Gift links

Change invitation reminders (retired)

Retired: always 410 CAPABILITY_RETIRED.

patch/campaigns/{id}/gift-link-settings

Request

  • Base URL: https://gtmswag.com/api/v1
  • URL: https://gtmswag.com/api/v1/campaigns/{id}/gift-link-settings
  • Auth: HTTP bearer

Path parameters

idstring required

Campaign or playbook ID (cmp_).

Request body

object required

Response

Any other refusal or failure, such as 403 CSRF (a cross-origin Origin header), 403 HTTPS_REQUIRED or 500 INTERNAL_ERROR, with what to do next.

errorstring required

Readable reason.

codestring required

Stable code, such as PLAYBOOK_OFF or RATE_LIMIT. Each operation lists the codes it returns.

nextAction'open_url' | 'reread_and_retry' | 'ask_user' | 'retry_later' | 'stop' required

open_url: a person resolves this at url; reread_and_retry: state changed, and a retry based on current state can succeed; ask_user: missing or corrected input is needed; retry_later: a retry after retryAfterMs can succeed; stop: retrying cannot succeed.

urlstring

Absolute page where a person resolves this refusal.

retryableboolean required

True when retrying can succeed without a person.

retryAfterMsinteger

Milliseconds to wait before retrying.

Changes

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