API Reference

Error Codes

These response codes provide a more detailed description of any problems which may have occurred with an API.

Generic Errors (1–99)

CodeMessage
1retailerId not found in authorization
2Informed Content-Type header is not allowed
3Invalid Query
4Request payload invalid

Audience Errors (100–199)

CodeMessage
100Audience not found
101Only one file allowed
102file exceeded 6 MB limit
103Invalid audience in base64
104Unsupported file, here are the allowed files: [csv]
105Exceeded limit of 100000 rows.
106The file structure is invalid
107No imports for the informed audience
108There is import in progress for the informed audience. Please try again in a few moments
109There is pending import for the informed audience. Please try again in a few moments
110There is only import failure for the informed audience
111No ready import for informed audience
112No audience validation data for the provided import
113Parameter "tokenDefinitions" is required for dynamic audience type
114Parameter "type" is required for application/json content-type
115Parameter "audience" not allowed for dynamic audiences
116Static type not allowed for application/json content-type
117Dynamic type not allowed for multipart/form-data content-type
118Parameter "file" is required for static type audience
119Only dynamic audience allow to adding contacts
120Invalid contacts JSON
121Audience provided is not from campaign provided
122Invalid tokenDefinitions attribute
123Only audience with error
124Audience type cannot be changed
125Unable to update audience while the campaign associated with that audience is in progress

Campaign Errors (200–299)

CodeMessage
200Campaign not found
201Campaign channel already exists
202Campaign its already progress
203Invalid campaign status for scheduling
204Campaign with static audience can only dispatch test
205Campaign invalid status finish
206Platform type already exists
207Missing contacts to dispatch
208The limit for test contacts is 5
209The limit for contacts is 50
210Invalid context json value format
211Context total max side exceeded
212The context token is reserved to add data to dispatched messages and cannot be used as a token definition
213The context token is reserved to add data to dispatched messages and cannot be used as a column of provided file
214Campaign does not have a segmented audience
215Campaign status is already
216It is not possible to update the status of a finalized or archived campaign
217Activation and Deactivation allowed only for campaigns with reactive audience
218Segment is mandatory for recurring campaigns
219The "activateOnCreate" field is only allowed for campaigns of type recurring
220Failed to create router rule. Invalid rule type, expected BOT
221Campaign status is archived

Channel Errors (300–399)

CodeMessage
300Campaign Channel not found
301The tokens are invalid
302Informed Integration is not ready
303Informed Integration not found
304Should be informed one token of type image for template type IMAGE
305Token attribute isFixed for type image should be true
306Invalid tokens quantity
307Should be informed one token of type video for template type VIDEO
308Token attribute isFixed for type document should be true
309Should be informed one token of type document for template type DOCUMENT
310Token attribute isFixed for type video should be true
311Informed Template is not ready
312Informed template not found

Schedule Errors (400–499)

CodeMessage
400Invalid schedule date
410Schedule not found
411No schedule found to cancel
412The limit provided exceeds the total number of dispatch available for scheduling
413Unable to update campaign audience with existing dispatches
414Unable to update campaigns scheduled to dispatch in the next minute
415Unable to update scheduled to dispatch in the next minute
416Cannot remove limit of a schedule. It must be cancelled
417There is another schedule without limit
420Invalid phone number
421Invalid cron expression
422Failed to create a recurring schedule because the campaign already has a non-recurring schedule. A campaign cannot have both types of schedules. Please remove the existing non-recurring schedule before adding a recurring one.
423Campaign must have reactive audience when schedule type is recurring
424Recurring schedules with overlap
425Campaigns with reactive audience cannot have non-recurring schedules
426Resource could not be found
427Unable to validate schedule payload
428Unable to get the CDP token
429The number of hours in the timetable exceeds the limit of 50 items.
430The hours in the timetable must be in the format "HH:mm".
431The number of weekdays in the timetable exceeds the limit of 7 items.
432The weekdays in the timetable must be between 1 and 7.
433Each schedule must have either a cron expression or a timetable
434Only schedules with SCHEDULED or PAUSED status can be updated or deleted

Dispatch Errors (600–699)

CodeMessage
600Dispatch not found

Campaigns Search Errors (700–799)

CodeMessage
700Invalid query
701Limit cannot be greater than 100
702Campaign name already exists
703Invalid filter key expression
704Invalid key data for filter
705Invalid campaign index

Rules Errors (800–899)

CodeMessage
800Invalid rule type. Expected BOT.
801Rule not found.