Delete Recipient Messages

DELETE 
/agreements/:agreement_id/recipient_messages

Deletes all recipient messages for the agreement. Keep in mind, if the template is saved in your archive, it will NOT be removed from there, only from the agreement.

Request

Path Parameters

agreement_id cuidrequired

DELETE /agreements/:agreement_id/recipient_messages parameter

Responses

200

DELETE /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: [deleted]

Returns a single object of the recipient_message resource which was deleted.

resource_type stringrequired

Possible values: [recipient_message]

Data contains the recipient_message resource.

data objectrequired

The resource data that was deleted.

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": "deleted",
  "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

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