List Template Variables

GET 
/agreements/:agreement_id/recipient_messages/message_template_variables

Lists all message template variable defined for the recipient message.

Request

Path Parameters

agreement_id cuidrequired

GET /agreements/:agreement_id/recipient_messages/message_template_variables parameter

Responses

200

GET /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: [list]

A non-paginated list 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 object[]required
Array [
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": "list",
  "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

GET /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...