Update a Custom Experience

patch

https://api-sandbox.yousign.app/v3/custom_experiences/{customExperienceId}

Updates a given Custom Experience. Any parameters not provided are left unchanged.

Path Params

customExperienceId

uuid

required

Custom Experience Id

Body Params

name

string

This property is a Safe String.

landing_page_disabled

boolean | null

side_panel_disabled

boolean | null

background_color

string | null

Hexadecimal color value

button_color

string | null

Hexadecimal color value

text_color

string | null

Hexadecimal color value

text_button_color

string | null

Hexadecimal color value

disabled_notifications

array of objects | null

disabled_notifications

email_logo_disabled

boolean | null

email_header_text_disabled

boolean | null

email_footer_signature_disabled

boolean | null

email_expiration_text_disabled

boolean | null

recipients_activity_disabled

boolean | null

download_documents_disabled

boolean | null

If true, signers won't be able to download documents before signing.

document_navigation_disabled

boolean | null

Defaults to false

If true and the request contains more than 1 document, signers must read each document before moving to the next.

redirect_urls

object | null

logo_layout

string

enum

Determines the display layout of the logo. Possible values are:

round: Displays the logo in a circular format.
original: Displays the logo in its original shape.

Allowed:

Responses

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad request

401Access unauthorized

403Access forbidden

404Resource not found

405This method is not allowed

415UnsupportedMediaType

429Too Many Requests, please try again later.

500Internal Server Error