API Reference
Status PageRoadmapTestimoniesShare feedback
  1. Settings & Administration
  2. Custom Experience

Update a Custom Experience

patch
https://api-sandbox.yousign.app/v3/custom_experiences/

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Related guide: Custom Experience

🔓 Endpoint access

  • Environments: production, sandbox
  • API key scopes: organization, workspace
  • Plans: pro, scale
  • Add-ons (for production access): none
Path Params
uuid
required

Custom Experience Id

Body Params
string

This property is a Safe String.

boolean | null
boolean | null
string | null
^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)

Hexadecimal color value

string | null
^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)

Hexadecimal color value

string | null
^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)

Hexadecimal color value

string | null
^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)

Hexadecimal color value

disabled_notifications
array of objects | null
disabled_notifications
boolean | null
boolean | null
boolean | null
boolean | null
boolean | null
boolean | null

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

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
embedded_preparation_navigation_bar
object | null

Navigation bar of the Embedded Preparation page.
An explicit null hides the whole navigation bar and both button settings are then ignored.
When omitted, the current value is kept.

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:
uuid | null

If set, scopes the Custom Experience to a single Workspace. If null, the Custom Experience is Organization-wide. When omitted, the current value is kept.

Responses

Updated 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago