message

Create a new message

post/v1/org/{orgId}/message

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/message
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

idstring

globally unique id

orgIdstring

parent organization id

type'CHAT' | 'EMAIL' | 'WEB'

type of message

notificationType'SUCCESS' | 'WARN' | 'ERROR' | 'COMMENT' | 'TASK_COMPLETED' | 'TASK_ASSIGNED' | 'REMINDER' | 'ANNOUNCEMENT' | 'PROCESS_ERROR' | 'PROCESS_DONE' | 'SHARE'

type of notification (SUCCESS, ERR, ANNOUNCEMENT etc.)

userIdstring

user who receives the message

contentobject

message content

titlestring

message title

messageUrlstring

link to message content (if applicable)

keystring

key of message if applicable (e.g. product-tour, import-complete-{id})

readAtstring

read timestamp

seenAtstring

seen timestamp

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

Example request

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "userId": "588f7ee98f138b19220041a7",
  "readAt": "2017-01-24T13:57:52Z",
  "seenAt": "2017-01-24T13:57:52Z",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  }
}

Response

message created

idstring required

globally unique id

orgIdstring required

parent organization id

type'CHAT' | 'EMAIL' | 'WEB' required

type of message

notificationType'SUCCESS' | 'WARN' | 'ERROR' | 'COMMENT' | 'TASK_COMPLETED' | 'TASK_ASSIGNED' | 'REMINDER' | 'ANNOUNCEMENT' | 'PROCESS_ERROR' | 'PROCESS_DONE' | 'SHARE' required

type of notification (SUCCESS, ERR, ANNOUNCEMENT etc.)

userIdstring required

user who receives the message

contentobject

message content

titlestring

message title

messageUrlstring

link to message content (if applicable)

keystring

key of message if applicable (e.g. product-tour, import-complete-{id})

readAtstring

read timestamp

seenAtstring

seen timestamp

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring required

created timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "userId": "588f7ee98f138b19220041a7",
  "readAt": "2017-01-24T13:57:52Z",
  "seenAt": "2017-01-24T13:57:52Z",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  }
}

Changes

No recorded changes to this operation across all 20 revisions of this API.