Create a Template Variable

POST 
/agreements/:agreement_id/recipient_messages/message_template_variables

Create a message template variable for the agreement.

Request

Path Parameters

agreement_id cuidrequired

POST /agreements/:agreement_id/recipient_messages/message_template_variables parameter

application/json

Body

POST /agreements/:agreement_id/recipient_messages/message_template_variables request body

variable_value stringrequired

The value of the variable. Booleans and numbers must be passed as string, but will be parsed into their native types when used. All values will be sanitized.

variable_name stringrequired

The name of the variable. All values will be sanitized.

Responses

200

POST /agreements/:agreement_id/recipient_messages/message_template_variables 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 recipient_message_template_variable resource.

resource_type stringrequired

Possible values: [recipient_message_template_variable]

Data contains the recipient_message_template_variable resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the recipient message variable

resource_type stringrequired

Possible values: [recipient_message_template_variable]

variable_name stringrequired

variable_value stringrequired

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": "recipient_message_template_variable",
  "data": {
    "id": "cutvu1wh0v5nshh7u4mexample",
    "resource_type": "recipient_message_template_variable",
    "variable_name": "string",
    "variable_value": "string",
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

400

POST /agreements/:agreement_id/recipient_messages/message_template_variables 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...