Skip to main content
POST
Start an identity-bound durable HTTP operation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
integration
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
method
enum<string>
required
Available options:
GET,
HEAD,
POST,
PUT,
PATCH,
DELETE,
OPTIONS
path
string
required
Required string length: 1 - 8192
headers
object
execution
enum<string>
Available options:
sync,
async
idempotencyKey
string
Required string length: 1 - 160
maxResultBytes
integer
Required range: 2048 <= x <= 32768
bodySource
object
multipart
object[]
Required array length: 1 - 16 elements
body
string
Maximum string length: 44739244
encoding
enum<string>
default:utf8
Available options:
utf8,
base64

Response

Durable operation state

operationId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
state
enum<string>
required
Available options:
queued,
running,
complete,
failed,
canceled,
uncertain
status
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
size
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
partial
boolean
required
effectsUncertain
boolean
required
error
object | null
required
expiresAt
string
required
instructions
string
required
responseHandle
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$