Campaigns

Update campaign settings

Changes only the fields you send. Same fields as create. Campaigns send plain text; plain_text: false is refused.

CostWhat it doesKey scopes
FreeWritesargorant:manage_lists
patch/api/v1/campaigns/{campaign_id}

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/campaigns/{campaign_id}
  • Auth: HTTP bearer

Path parameters

campaign_idstring uuid required

The campaign id from create or list.

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

namestring

New name.

daily_limitinteger

Emails a day for the whole campaign.

include_unsubscribeboolean

Add or remove the opt-out line.

window_startstring

HH:MM.

window_endstring

HH:MM.

Response

OK

changedstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.