---
title: "Workflow Campaigns API"
url: "https://earlyaccess.developers.bynder.com/apis/workflow-campaigns-api-1/versions/e0ad0bb4-8312-4ba5-bc53-d0218db2d92e"
---

# Workflow Campaigns API

OpenAPI specification document.

```json
{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNOVERVIEW":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNOVERVIEW":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Workflow Campaigns API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/workflow/campaigns":{"get":{"description":"Requires the CAMPAIGNOVERVIEW security role.","responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"ID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"accountID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"campaignMetaproperties":{"additionalProperties":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"type":"object"},"closed":{"example":false,"type":"boolean"},"createdByID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"dateCreated":{"example":"2017-01-10T07:43:12+00:00","format":"date-time","type":"string"},"dateModified":{"example":"2017-01-10T07:43:12+00:00","format":"date-time","type":"string"},"dateStart":{"example":"2017-02-01T00:00:00+00:00","format":"date-time","type":"string"},"deadline":{"example":"2017-03-03T00:00:00","format":"date","type":"string"},"description":{"example":"Campaign example","type":"string"},"key":{"example":"excp","type":"string"},"name":{"example":"Example campaign","type":"string"},"presetID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"responsibleID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"thumbnailURL":{"example":"https://bynder-public-eu-central-1.s3.eu-central-1.amazonaws.com:443/workflow/campaign/988BBB04-F0E2-4A28-B5F892890849BAFE/FEE78434-649A-449B-A62A1C6C6D59CAC3/500x500.jpg","type":"string"}},"type":"object"},"type":"array"}}},"description":"Successfully retrieved campaigns"}},"security":[{"OAuth2":["CAMPAIGNOVERVIEW"]},{"permanentToken":["CAMPAIGNOVERVIEW"]}],"summary":"Retrieve campaigns","tags":["Campaigns"]},"post":{"description":"Requires the CAMPAIGNADD security role.","requestBody":{"content":{"application/json":{"schema":{"properties":{"campaignMetaproperties":{"additionalProperties":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"type":"object"},"closed":{"example":false,"type":"boolean"},"dateStart":{"example":"2015-01-01T00:00:00","format":"date","type":"string"},"deadline":{"example":"2015-09-04T00:00:00","format":"date","type":"string"},"description":{"example":"Campaign example","type":"string"},"key":{"example":"excp","type":"string"},"name":{"example":"Example campaign","type":"string"},"responsibleID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"example":"00000000000000000000000000000000","type":"string"}},"type":"object"}}},"description":"Campaign created successfully","headers":{"Location":{"description":"URL of the created campaign","schema":{"example":"https://your-bynder-domain/api/workflow/campaigns/00000000-0000-0000-0000-000000000000/","type":"string"}}}}},"security":[{"OAuth2":["CAMPAIGNADD"]},{"permanentToken":["CAMPAIGNADD"]}],"summary":"Create campaign","tags":["Campaigns"]}},"/api/workflow/campaigns/{id}":{"delete":{"description":"Requires the CAMPAIGNREMOVE security role.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","type":"string"}}],"responses":{"204":{"description":"Campaign deleted successfully"}},"security":[{"OAuth2":["CAMPAIGNREMOVE"]},{"permanentToken":["CAMPAIGNREMOVE"]}],"summary":"Delete campaign","tags":["Campaigns"]},"get":{"description":"Requires the CAMPAIGNOVERVIEW security role.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"ID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"accountID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"campaignMetaproperties":{"additionalProperties":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"type":"object"},"closed":{"example":false,"type":"boolean"},"createdByID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"dateCreated":{"example":"2017-01-10T07:43:12+00:00","format":"date-time","type":"string"},"dateModified":{"example":"2017-01-10T07:43:12+00:00","format":"date-time","type":"string"},"dateStart":{"example":"2017-02-01T00:00:00+00:00","format":"date-time","type":"string"},"deadline":{"example":"2017-03-03T00:00:00","format":"date","type":"string"},"description":{"example":"Campaign example","type":"string"},"key":{"example":"excp","type":"string"},"name":{"example":"Example campaign","type":"string"},"presetID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"responsibleID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"thumbnailURL":{"example":"https://bynder-public-eu-central-1.s3.eu-central-1.amazonaws.com:443/workflow/campaign/988BBB04-F0E2-4A28-B5F892890849BAFE/FEE78434-649A-449B-A62A1C6C6D59CAC3/500x500.jpg","type":"string"}},"type":"object"}}},"description":"Successfully retrieved specific campaign"}},"security":[{"OAuth2":["CAMPAIGNOVERVIEW"]},{"permanentToken":["CAMPAIGNOVERVIEW"]}],"summary":"Retrieve specific campaign","tags":["Campaigns"]},"post":{"description":"Requires the CAMPAIGNWRITE security role.","operationId":"closeCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","type":"string"}}],"responses":{"204":{"description":"Campaign closed successfully"},"404":{"description":"Campaign not found"}},"security":[{"OAuth2":["CAMPAIGNWRITE"]},{"permanentToken":["CAMPAIGNWRITE"]}],"summary":"Close campaign","tags":["Campaigns"]},"put":{"description":"Requires the CAMPAIGNEDIT security role.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"campaignMetaproperties":{"additionalProperties":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"type":"object"},"closed":{"example":false,"type":"boolean"},"dateStart":{"example":"2015-01-01T00:00:00","format":"date","type":"string"},"deadline":{"example":"2015-09-04T00:00:00","format":"date","type":"string"},"description":{"example":"Campaign for managing examples","type":"string"},"key":{"example":"excp","type":"string"},"name":{"example":"Example campaign","type":"string"},"responsibleID":{"example":"00000000-0000-0000-0000-000000000000","type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"example":"00000000000000000000000000000000","type":"string"}},"type":"object"}}},"description":"Campaign modified successfully"}},"security":[{"OAuth2":["CAMPAIGNEDIT"]},{"permanentToken":["CAMPAIGNEDIT"]}],"summary":"Modify campaign","tags":["Campaigns"]}}},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"description":"","name":"Campaigns"}]}
```