Create a Theme

POST 
/themes

Create a new theme. Use the theme ID in subsequent requests.

Request

application/json

Body

POST /themes request body

primary_color string

Possible values: non-empty

Default value: #000000

The primary color used to generate the color palette

logo_file_id cuidrequired

Possible values: non-empty

The ID of the uploaded logo. Upload the logo to the /files endpoint. Must be a jpeg or png file.

icon_file_id cuidrequired

Possible values: non-empty

The ID of the uploaded icon. Upload the icon to the /files endpoint. Must be a jpeg or png file.

lookup_key string

Arbitrary string which can be used to identify the theme in future requests.

Responses

200

POST /themes Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the theme resource.

resource_type stringrequired

Possible values: [theme]

Data contains the theme resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the theme

resource_type stringrequired

Possible values: [theme]

logo objectrequired

The logo of the theme. This is displayed to the user in all communication and touch points.

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the file resource.

resource_type stringrequired

Possible values: [file]

Data contains the file resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the file

resource_type stringrequired

Possible values: [file]

filename stringrequired

Possible values: non-empty

The complete filename including the file extension

mime_type stringrequired

Possible values: non-empty

The mime type of the file

url url

The signed read url of the file

metadata object

lookup_key stringrequired

A provided lookup key provided by you to help you identify the file.

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

icon objectrequired

The icon of the theme. This is used for the favicon.

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the file resource.

resource_type stringrequired

Possible values: [file]

Data contains the file resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the file

resource_type stringrequired

Possible values: [file]

filename stringrequired

Possible values: non-empty

The complete filename including the file extension

mime_type stringrequired

Possible values: non-empty

The mime type of the file

url url

The signed read url of the file

metadata object

lookup_key stringrequired

A provided lookup key provided by you to help you identify the file.

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

primary_color string

Default value: #000000

The primary color used to create the color palette in the signing room.

metadata object

lookup_key stringrequired

A provided lookup key provided by you to help you identify the theme.

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

Example (from schema)

{
  "version": "1.0",
  "result_type": "single",
  "resource_type": "theme",
  "data": {
    "id": "cqztbapr1qfgric9izbexample",
    "resource_type": "theme",
    "logo": {
      "version": "1.0",
      "result_type": "single",
      "resource_type": "file",
      "data": {
        "id": "cdypzghb8xpdp4c6kgvexample",
        "resource_type": "file",
        "filename": "my-file.pdf",
        "mime_type": "application/pdf",
        "url": "https://zigned.se",
        "metadata": {
          "lookup_key": "file_tag"
        },
        "created_at": "2024-01-01T00:00:00.000Z",
        "updated_at": "2024-01-01T00:00:00.000Z"
      }
    },
    "icon": {
      "version": "1.0",
      "result_type": "single",
      "resource_type": "file",
      "data": {
        "id": "cdypzghb8xpdp4c6kgvexample",
        "resource_type": "file",
        "filename": "my-file.pdf",
        "mime_type": "application/pdf",
        "url": "https://zigned.se",
        "metadata": {
          "lookup_key": "file_tag"
        },
        "created_at": "2024-01-01T00:00:00.000Z",
        "updated_at": "2024-01-01T00:00:00.000Z"
      }
    },
    "primary_color": "#000000",
    "metadata": {
      "lookup_key": "your_internal_customer_id"
    },
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

400

POST /themes Error response

application/json

Schema

Schema

status stringrequired

Possible values: [error]

error objectrequired
code int64required
Possible values: >= 400 and <= 599
message stringrequired
request_id uuidrequired

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "message": "string",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Loading...