...
Excerpt |
---|
Retrieves all available push communication messages for an account. |
Endpoint ID: | 7001 | |||||||||||||||||||||||||||
Method: |
| |||||||||||||||||||||||||||
URL: | /communication/push/entity/id/{entity-id}?onlyHeaders=true /communication/push/entity/ext-key/{ext-key}/{ext-type}?onlyHeaders=false | |||||||||||||||||||||||||||
entity-id | Rubiq entity ID that uniquely identifies the account to retrieve the message for | |||||||||||||||||||||||||||
ext-key | External key that uniquely identifies the account to retrieve the message for | |||||||||||||||||||||||||||
ext-type | Type of external key | |||||||||||||||||||||||||||
onlyHeaders | Optional: boolean to specify whether only message headers should be retrieved. Default is false. | |||||||||||||||||||||||||||
Request body: | None | |||||||||||||||||||||||||||
Response body: | JSON data containing the push communication details of all available messages for the account.
The possible response body fields are:
* Use of the "link" and "type" properties should be decided between the app developer and the content producer | |||||||||||||||||||||||||||
Status codes: | 200 | Message retrieved successfully | ||||||||||||||||||||||||||
404 | Account was not found The following sub codes may be returned:
|