Add action

Allows users to post actions on a parent message. The server does not validate that the parent message exists at the time the action is posted. The server does, however, check that you have not already added this particular action to this message. In other words, for a given parent message (identified by sub_key, channel, timetoken), there is at most one unique (type, value) pair per UUID/userId. There is a limit to the total number of actions which can be posted on a given message (default 25000). If all goes well, the message action is stored in the database, and a specially structured Action add event message is published in on the same channel as the parent message.

Path Parameters
sub_key string — REQUIRED

Your app's subscribe key from Admin Portal.

Example: sub-c-50264475-1902-558x-d213-7p19052012n2

channel string — REQUIRED

The channel name to perform the operation on.

Example: myChannel

message_timetoken string — REQUIRED

The publish timetoken of a parent message.

Example: 15610547826970040

Query Parameters
auth string

String which is either the auth key (PAM v2) or a valid token (Access Manager) used to authorize the operation if access control is enabled.

Example: myAuth / p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI

uuid string — REQUIRED

A UTF-8 encoded string of up to 92 characters used to identify the client.

Example: myUniqueUserId

signature string

Signature used to verify that the request was signed with the secret key associated with the subscribe key.

If Access Manager is enabled, either a valid authorization token or a signature are required.

Check Access Manager documentation for details on how to compute the signature.

timestamp integer

Unix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP.

Required if the signature parameter is supplied.

Request Body — REQUIRED

JSON object with user properties.

type string
value string
Responses
200

The message action was successfully added.

Schema — OPTIONAL
status integer — OPTIONAL
data object — OPTIONAL
type string — OPTIONAL
value string — OPTIONAL
actionTimetoken string — OPTIONAL
messageTimetoken string — OPTIONAL
uuid string — OPTIONAL
207

The message action was stored but failed to publish.

Schema — OPTIONAL
status integer — OPTIONAL
data object — OPTIONAL
type string — OPTIONAL
value string — OPTIONAL
actionTimetoken string — OPTIONAL
messageTimetoken string — OPTIONAL
uuid string — OPTIONAL
error object — OPTIONAL
status integer — OPTIONAL
error object — OPTIONAL
message string — OPTIONAL
source string — OPTIONAL
400

The post request contained invalid parameters.

Schema — OPTIONAL
status integer — OPTIONAL
error object — OPTIONAL
message string — OPTIONAL
source string — OPTIONAL
details object[] — OPTIONAL
message string — OPTIONAL
location string — OPTIONAL
locationType string — OPTIONAL
403

The client isn't authorized to perform this operation. The authorization key you provided doesn't have the required permissions for this operation.

Schema — OPTIONAL
status integer — OPTIONAL
error object — OPTIONAL
source string — OPTIONAL
message string — OPTIONAL
409

The action was already added

Schema — OPTIONAL
status integer — OPTIONAL
error object — OPTIONAL
message string — OPTIONAL
source string — OPTIONAL