StartInstance
POST
/api/v1/t/{tenant}/workflows/instances
const url = 'https://example.com/api/v1/t/example/workflows/instances';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"documentId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","definitionId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/t/example/workflows/instances \ --header 'Content-Type: application/json' \ --data '{ "documentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "definitionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”tenant
required
string
Tenant slug
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
documentId
required
string format: uuid
definitionId
required
string format: uuid
Examplegenerated
{ "documentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "definitionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “ Responses ”Created
Media typeapplication/json
object
instanceId
required
string format: uuid
Examplegenerated
{ "instanceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Forbidden
Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
Too Many Requests
Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}