Create a campaign

post

https://api.sintalk.com.br/v3/campaigns

Create a campaign that sends one template to every contact of one list. The campaign's channel is the template's channel; the list must not be a blacklist-type list, which is a suppression set rather than an audience.

The campaign starts in draft: nothing is sent until it is launched, and until then it can be renamed, scheduled, or deleted. Template and contact list are fixed at creation — only name can be changed afterwards.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The campaign as created, in draft, having produced no messages yet.

400The request was rejected before it was applied — either a field failed validation (validation_failed, with error.fields naming each one), or the request could not be read at all (bad_request: malformed JSON, an unknown field, a missing parameter, or an unparseable path or query value).

401No credential was presented, or the one presented was rejected.

403The credential is valid but is not allowed to call this operation.

404No resource with that id exists in your account. An id belonging to another account is reported the same way as one that never existed.

409The request collides with what already exists, or with the resource's current state. Re-read the resource before retrying.

422The body parsed and every field is individually valid, but the request cannot be applied as asked. Retrying it unchanged will fail again.

429Rate limit exceeded

defaultAn unexpected error. Safe to retry with backoff; use an idempotency key where the operation accepts one.