Get Message
GET /v2/partner/messages/{id}
Required scopes
partner:messages:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getMessage |
| Tags | Campaigns |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id * | path | id |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | message |
| template_id * | id | UUID v4. |
| channel * | enum (3) | emailsmspush |
| name * | string | |
| subject | string | |
| preview_text | string | |
| from_name | string | |
| from_address | string | |
| reply_to | string | |
| body_html | string | |
| body_plain | string | |
| push_title | string | |
| push_body | string | |
| send_offset_hours * | number | |
| is_archived * | boolean | |
| is_active * | boolean | |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| updated_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
Example request
GET https://api.digitalonboarding.com/v2/partner/messages/{id}
Authorization: Bearer <partner-token>