Execute Operation

POST /v2/ipaas/operations/{operation_kind}

Required scopes

ipaas:operations:execute

Tokens missing any required scope return 401 scope_missing. See Auth & Scopes for issuance.

Operation

Operation ID executeOperation
Tags Operations

Parameters

Name In Type Description
operation_kind * path string OperationKind per RFC-operations-registry.md §5 (e.g., contacts.upsert_single, objectives.complete)

Request body

Required

object

Per-operation input schema; see RFC-operations-registry §5

Responses

200
Synchronous operation succeeded.
object

Per-operation OperationOutput per RFC-operations-registry §5

202
Asynchronous operation queued; returns a Batch ref.
object
FieldTypeDescription
id *idUUID v4.
surface *enum (3)
partneripaasbatch
operation *enum (11)Per 04-batch.md §3.1. Includes session-6 addition `incoming_webhooks.replay`.
contacts.upsertaccounts.upsertengagement_events.backfillmessages.sendjourneys.enroll_cohortjourneys.bulk_cancelcohorts.materializecohorts.materialize_to_audienceobjectives.bulk_completewebhooks.bulk_replayincoming_webhooks.replay
status *enum (6)
acceptedrunningsucceededpartially_failedfailedcancelled
source *oneOf<object | object | object | object>
created_at *occurred_atRFC 3339 / ISO 8601 timestamp.
started_atoccurred_atRFC 3339 / ISO 8601 timestamp.
completed_atoccurred_atRFC 3339 / ISO 8601 timestamp.
progress *object
errors_urlstring
result_urlstring
idempotency_key *string
400
Validation, sort/filter, or window error.
object
FieldTypeDescription
errors *object[]
401
Missing/expired token, or scope missing.
schema
403
Forbidden (override required, scope insufficient, resource-level).
schema
409
Idempotency conflict or invalid state transition.
schema
422
Schema validation failed.
schema
429
Rate limit exceeded. See Retry-After + RateLimit-* headers.
schema

Example request

POST https://api.digitalonboarding.com/v2/ipaas/operations/{operation_kind}
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>

{ /* request body matching schema above */ }