Search
K
Workflow Jobs

Create job

Requires the JOBADD security role.

post
https://{your-bynder-domain}/api/workflow/jobs

Body

application/json
accountableIDstring

Id of the user responsible for the job

Example:00000000-0000-0000-0000-000000000000

campaignIDstring

Id of the campaign the job is part of

Example:00000000-0000-0000-0000-000000000000

deadlinestring

Date of when the job ends

Example:2018-09-29

descriptionstring

Description of the job

Example:Job Description

jobMetapropertiesobject

ID and metaproperty values

Example:{"00000000-0000-0000-0000-000000000000":"00000000-0000-0000-0000-000000000000"}

namestring

Name of the job

Example:Job Example

presetIDstring

Id of the preset the job should be created from

Example:00000000-0000-0000-0000-000000000000

stagesarray[object]
Show Child Parameters

Response

201 application/json

Job created successfully

job_idstring

Example:00000000-0000-0000-0000-000000000000

statusstring

Example:Created

post/api/workflow/jobs

Body

{}
 
201 application/json

Delete job

Requires the JOBREMOVE security role.

delete
https://{your-bynder-domain}/api/workflow/jobs/{id}

Path Parameters

idstringrequired

Example:00000000-0000-0000-0000-000000000000

Response

204 application/json

No Content

delete/api/workflow/jobs/{id}
 
204 application/json

Retrieve specific job

Requires the JOBOVERVIEW security role.

get
https://{your-bynder-domain}/api/workflow/jobs/{id}

Path Parameters

idstringrequired

Example:00000000-0000-0000-0000-000000000000

Response

200 application/json

Successful response

accountableIDstring
basedOnPresetstring
bookedMinutesnumber
campaignIDstring
createdByIDstring
dateCreatedstring
dateFinishedstring
dateModifiedstring
deadlinestring
descriptionstring
idstring
jobFinishedHistoryarray[object]
Show Child Parameters
jobKeystring
jobMetapropertiesobject
job_active_stageobject
Show Child Parameters
job_next_stageobject
Show Child Parameters
job_previous_stageobject
Show Child Parameters
job_stagesarray[object]
Show Child Parameters
namestring
presetIDstring
get/api/workflow/jobs/{id}
 
200 application/json

Modify job

Requires the JOBEDIT security role. Note: responsibleID and responsibleGroupID cannot be set on previousStage, activeStage, or nextStage through this endpoint. To update a stage’s responsible user or group, use PUT /api/workflow/stages/{id}.

put
https://{your-bynder-domain}/api/workflow/jobs/{id}

Path Parameters

idstringrequired

Example:00000000-0000-0000-0000-000000000000

Body

application/json
accountableIDstring

Id of the user accountable for the job (displayed as Reporter in the UI). This does not update a stage’s responsible user or group; use PUT /api/workflow/stages/{id} for that.

Example:00000000-0000-0000-0000-000000000000

activeStageobject

The new active stage of the job

Show Child Parameters
campaignIDstring

Id of the campaign the job is part of

Example:00000000-0000-0000-0000-000000000000

deadlinestring

Date of when the job ends

Example:2018-09-29

descriptionstring

Description of the job

Example:Job Description

jobMetapropertiesobject

ID and metaproperty values

Example:{"00000000-0000-0000-0000-000000000000":"00000000-0000-0000-0000-000000000000"}

namestring

Name of the job

Example:Job Example

nextStageobject

The new next stage of the job

Show Child Parameters
previousStageobject

The new previous stage of the job

Show Child Parameters

Response

200 application/json

Successful response

job_idstring

Example:00000000-0000-0000-0000-000000000000

statusstring

Example:Updated

put/api/workflow/jobs/{id}

Body

{ "accountableID": "00000000-0000-0000-0000-000000000000", "activeStage": { "id": "00000000-0000-0000-0000-000000000002", "status": "Active" }, "campaignID": "00000000-0000-0000-0000-000000000000", "deadline": "2018-09-29", "description": "Job Description", "jobMetaproperties": { "00000000-0000-0000-0000-000000000000": "00000000-0000-0000-0000-000000000000" }, "name": "Job Example", "nextStage": { "deadline": "2024-08-31T00:00:00+00:00", "id": "00000000-0000-0000-0000-000000000003", "status": "Idle" }, "previousStage": { "deadline": null, "id": "00000000-0000-0000-0000-000000000001", "status": "Approved" } }
 
200 application/json

Campaign jobs