POST
/
messages
/

A group must be provided for creating a review.

You can provide either a group id through the group_id parameter or a group external reference through the group_external_ref attribute.

Do not provide both, as this will result in the request failing.

If no group id or group external reference is provided, the operation will fail.

Currently the endpoint will only process review messages, any other types of messages will not be processed.

All datetime fields included in the body parameters need to be specified as ISO8601-formatted date strings.

Datetime fields should follow a “YYYY-MM-DDThh:mm:ss” format.

Authorization
string
default: "none"required

The authentication token for your request

​
Body

group_id
string
default: "none"

The id of the group you want to create or update the message for.

group_external_ref
string
default: "none"

The external reference of the group you want to create or update the message for.

channel
enum
default: "none"

The channel of the message. Possible value: review.

review
object
default: "none"

The review message to be ingested.

​
Response

request_id
string

The UUID of the request.

​
Errors

Listed below are common errors that may be returned by the endpoint, along with their corresponding status code.

Status Code - 400

Missing Authorization header
{
   "error": {
    "type": "missing_authorization",
    "message": "Your request does not include an 'Authorization' header with a bearer token for your account."
  }
}

Status Code - 401

Expired Authorization header bearer token value
{
   "error": {
    "type": "expired_token",
    "message": "The bearer token you have provided in the 'Authorization' header has expired. Please obtain a new one."
  }
}

Status Code - 401

Invalid Authorization header bearer token value
{
   "error": {
    "type": "invalid_authorization",
    "message": "The bearer token you have provided in the 'Authorization' header is invalid."
  }
}

Status Code - 400

Returned if no group id or external reference is passed in the body.

No group id or external reference supplied
{
   "error": {
    "type": "no_group",
    "message": "You must either provide a group id or group external reference in the request body."
  }
}

Status Code - 400

Returned if both a group id and group_external_ref are provided

Both group id and external ref provided for the unit post-multiple operation
{
   "error": {
    "type": "both_group_identifiers_provided",
    "message": "You have provided both a group id and group external reference for the create/update units operation. Please only provide one of the two."
  }
}

Status Code - 401

Returned if the authenticated API user does not have access to the requested group.

No access to the provided group
{
   "error": {
    "type": "no_access_to_group",
    "message": "You do not have access to the group you have provided."
  }
}

Status Code - 404

Returned if no group for the provided group ID is found

Group with provided ID not found
{
   "error": {
    "type": "group_not_found",
    "message": "We could not find a group with the ID you have provided."
  }
}
Task webhook eventsMessaging API