Sign in
campaigns

Cria uma campanha em massa

Requer plano PRO+ e número dedicado atrelado à organização. Header Idempotency-Key é obrigatório — mesmo header em retries retorna a mesma campanha.

post/v1/campaigns

Headers

Idempotency-Keystring required

Identificador único do retry (UUID recomendado).

Request body

namestring required
templateNamestring required
senderstring nullable

Response

Campanha criada

idstring uuid required
namestring required
statusstring required
totalMessagesinteger required
totalCostnumber float required

Changes

Changed in 1 of the 4 revisions of this API.2412

  • 4e426b85f7842412See the full diff
    • ▲

      the contacts request property's minItems was increased to 1

      request-property-min-items-increased

    • ▲

      the totalCost response's property type/format changed from number/decimal to number/float for status 200

      response-property-type-changed

    • ●

      removed the optional property failedMessages from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property internalId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organizationId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property processedMessages from the response with the 200 status

      response-optional-property-removed

    • ○

      api tag campaigns added

      api-tag-added

    • ○

      api tag Campaigns removed

      api-tag-removed

    • ○

      added the new optional request property sender

      new-optional-request-property

    • ○

      added the media type application/json for the response with the status 400

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 401

      response-media-type-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

    • ○

      the response property id became required for the status 200

      response-property-became-required

    • ○

      the response property name became required for the status 200

      response-property-became-required

    • ○

      the response property status became required for the status 200

      response-property-became-required

    • ○

      the response property totalCost became required for the status 200

      response-property-became-required

    • ○

      the response property totalMessages became required for the status 200

      response-property-became-required

    This revision also has 24 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog