Upsert a Recipient Message

POST 
/agreements/:agreement_id/recipient_messages

Upsert a new recipient message. Use the Recipient Message ID in subsequent requests.

Request

Path Parameters

agreement_id cuidrequired

POST /agreements/:agreement_id/recipient_messages parameter

application/json

Body

POST /agreements/:agreement_id/recipient_messages request body

message_templates object[]required
Array [
locale stringrequired
Possible values: [sv-SE, en-US]
template_string stringrequired
The message template string. Supports simple markdown and dynamic data variables via mustache syntax.
]
message_template_variables object[]
Array [
variable_name stringrequired
The name of the variable. Supports dot notation such as "my.variable.name". All values will be escaped and sanitized so refrain from uncommon characters or HTML.
variable_value stringrequired
The variable value. Must be provided as a string, but booleans and numbers will be parsed to their native types. Any HTML will be escaped.
]

Responses

200

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

resource_type stringrequired

Possible values: [recipient_message]

Data contains the recipient_message resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the recipient message

resource_type stringrequired

Possible values: [recipient_message]

message_templates objectrequired

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 resource.

resource_type stringrequired

Possible values: [recipient_message_template]

Data contains the recipient message template resource.

data object[]required

Array [

id cuidrequired

The unique identifier of the recipient message template

template_string stringrequired

resource_type stringrequired

Possible values: [recipient_message_template]

locale stringrequired

Possible values: [sv-SE, en-US]

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

]

message_template_variables objectrequired

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

]

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",
  "data": {
    "id": "cexfmnhnknefinudyzjexample",
    "resource_type": "recipient_message",
    "message_templates": {
      "version": "1.0",
      "result_type": "list",
      "resource_type": "recipient_message_template",
      "data": [
        {
          "id": "cy80mik8iwxn0jom970example",
          "template_string": "string",
          "resource_type": "recipient_message_template",
          "locale": "sv-SE",
          "created_at": "2024-01-01T00:00:00.000Z",
          "updated_at": "2024-01-01T00:00:00.000Z"
        }
      ]
    },
    "message_template_variables": {
      "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"
        }
      ]
    },
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

400

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