API Referenceredteam

Campaigns Create

Declare per-endpoint throttling configuration attributes for views. Endpoints can inherit this mixin and set: - endpoint_default_rate_limit_per_user_per_min: float | None When set (not None), throttling will use ONLY this default RPM for the endpoint without requiring API key / org attributes on the request. When unset, the standard API key / organization / subscription limits apply.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Request

This endpoint expects an object.
consentbooleanRequired
target_idstringOptional1-64 characters
targetmap from strings to anyOptional

Response

target_idstring<=64 characters
target_labelstring<=255 characters
created_atdatetimeRead-only
summaryobject or anyRead-only
idstring<=64 characters
statusenum
  • queued - Queued
  • running - Running
  • succeeded - Succeeded
  • failed - Failed
errorstring<=512 characters
started_atdatetime or null
finished_atdatetime or null
reportany

Errors

503
Service Unavailable Error