v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB

Custom Experience

Create a Custom Experience

Creates a new Custom Experience.

post/custom_experiences

Request body

namestring safe-string required

This property is a Safe String.

landing_page_disabledboolean nullable

side_panel_disabledboolean nullable

background_colorstring nullable

Hexadecimal color value

button_colorstring nullable

Hexadecimal color value

text_colorstring nullable

Hexadecimal color value

text_button_colorstring nullable

Hexadecimal color value

disabled_notificationsCustomExperienceDisabledNotificationsType[] nullable

email_logo_disabledboolean nullable

email_header_text_disabledboolean nullable

email_footer_signature_disabledboolean nullable

email_expiration_text_disabledboolean nullable

recipients_activity_disabledboolean nullable

download_documents_disabledboolean nullable

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

document_navigation_disabledboolean nullable

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

logo_layout'round' | 'original'

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.

Example request

{
  "background_color": "#ff0011",
  "button_color": "#ff0011",
  "text_color": "#ff0011",
  "text_button_color": "#ff0011",
  "disabled_notifications": [
    "approver.canceled"
  ],
  "redirect_urls": {
    "success": "https://example.com/success",
    "error": "https://example.com/error",
    "decline": "https://example.com/decline"
  },
  "logo_layout": "round"
}

Response

Created

idstring uuid required

namestring

landing_page_disabledboolean required

side_panel_disabledboolean required

background_colorstring nullable required

button_colorstring nullable required

text_colorstring nullable required

text_button_colorstring nullable required

disabled_notificationsCustomExperienceDisabledNotificationsType[] required

email_logo_disabledboolean required

email_header_text_disabledboolean required

email_footer_signature_disabledboolean required

email_expiration_text_disabledboolean required

recipients_activity_disabledboolean required

download_documents_disabledboolean required

document_navigation_disabledboolean required

logostring uri nullable required

source'app' | 'public_api' nullable required

Custom Experience Source

created_atstring date-time required

Example response

{
  "disabled_notifications": [
    "approver.canceled"
  ],
  "redirect_urls": {
    "success": "https://example.com/success",
    "error": "https://example.com/error",
    "decline": "https://example.com/decline"
  },
  "logo": "https://youtrust.com/custom_experience/89120884-d29a-4b1a-ac7b-a9e73a872795/logo",
  "source": "app",
  "created_at": "2024-01-18T22:59:00Z"
}