openapi: 3.2.0 info: title: Workflow Campaigns API version: 1.0.0 servers: - url: https://{your-bynder-domain} tags: - name: Campaigns description: '' paths: /api/workflow/campaigns: get: summary: Retrieve campaigns description: Requires the CAMPAIGNOVERVIEW security role. tags: - Campaigns security: - OAuth2: - CAMPAIGNOVERVIEW - permanentToken: - CAMPAIGNOVERVIEW responses: '200': description: Successfully retrieved campaigns content: application/json: schema: type: array items: type: object properties: dateStart: type: string format: date-time example: '2017-02-01T00:00:00+00:00' description: type: string example: Campaign example responsibleID: type: string example: 00000000-0000-0000-0000-000000000000 dateModified: type: string format: date-time example: '2017-01-10T07:43:12+00:00' dateCreated: type: string format: date-time example: '2017-01-10T07:43:12+00:00' ID: type: string example: 00000000-0000-0000-0000-000000000000 deadline: type: string format: date example: '2017-03-03T00:00:00' createdByID: type: string example: 00000000-0000-0000-0000-000000000000 accountID: type: string example: 00000000-0000-0000-0000-000000000000 presetID: type: string example: 00000000-0000-0000-0000-000000000000 closed: type: boolean example: false key: type: string example: excp name: type: string example: Example campaign thumbnailURL: type: string 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 campaignMetaproperties: type: object additionalProperties: type: string example: 00000000-0000-0000-0000-000000000000 post: summary: Create campaign description: Requires the CAMPAIGNADD security role. tags: - Campaigns security: - OAuth2: - CAMPAIGNADD - permanentToken: - CAMPAIGNADD requestBody: required: true content: application/json: schema: type: object properties: name: type: string example: Example campaign key: type: string example: excp description: type: string example: Campaign example dateStart: type: string format: date example: '2015-01-01T00:00:00' deadline: type: string format: date example: '2015-09-04T00:00:00' closed: type: boolean example: false responsibleID: type: string example: 00000000-0000-0000-0000-000000000000 campaignMetaproperties: type: object additionalProperties: type: string example: 00000000-0000-0000-0000-000000000000 responses: '201': description: Campaign created successfully headers: Location: description: URL of the created campaign schema: type: string example: https://your-bynder-domain/api/workflow/campaigns/00000000-0000-0000-0000-000000000000/ content: application/json: schema: type: object properties: id: type: string example: '00000000000000000000000000000000' /api/workflow/campaigns/{id}: get: summary: Retrieve specific campaign description: Requires the CAMPAIGNOVERVIEW security role. tags: - Campaigns security: - OAuth2: - CAMPAIGNOVERVIEW - permanentToken: - CAMPAIGNOVERVIEW parameters: - name: id in: path required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successfully retrieved specific campaign content: application/json: schema: type: object properties: ID: type: string example: 00000000-0000-0000-0000-000000000000 name: type: string example: Example campaign key: type: string example: excp closed: type: boolean example: false description: type: string example: Campaign example dateStart: type: string format: date-time example: '2017-02-01T00:00:00+00:00' deadline: type: string format: date example: '2017-03-03T00:00:00' accountID: type: string example: 00000000-0000-0000-0000-000000000000 presetID: type: string example: 00000000-0000-0000-0000-000000000000 createdByID: type: string example: 00000000-0000-0000-0000-000000000000 responsibleID: type: string example: 00000000-0000-0000-0000-000000000000 dateCreated: type: string format: date-time example: '2017-01-10T07:43:12+00:00' dateModified: type: string format: date-time example: '2017-01-10T07:43:12+00:00' thumbnailURL: type: string 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 campaignMetaproperties: type: object additionalProperties: type: string example: 00000000-0000-0000-0000-000000000000 put: summary: Modify campaign description: Requires the CAMPAIGNEDIT security role. tags: - Campaigns security: - OAuth2: - CAMPAIGNEDIT - permanentToken: - CAMPAIGNEDIT parameters: - name: id in: path required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 requestBody: required: true content: application/json: schema: type: object properties: name: type: string example: Example campaign key: type: string example: excp description: type: string example: Campaign for managing examples dateStart: type: string format: date example: '2015-01-01T00:00:00' deadline: type: string format: date example: '2015-09-04T00:00:00' closed: type: boolean example: false responsibleID: type: string example: 00000000-0000-0000-0000-000000000000 campaignMetaproperties: type: object additionalProperties: type: string example: 00000000-0000-0000-0000-000000000000 responses: '201': description: Campaign modified successfully content: application/json: schema: type: object properties: id: type: string example: '00000000000000000000000000000000' delete: summary: Delete campaign description: Requires the CAMPAIGNREMOVE security role. tags: - Campaigns security: - OAuth2: - CAMPAIGNREMOVE - permanentToken: - CAMPAIGNREMOVE parameters: - name: id in: path required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '204': description: Campaign deleted successfully post: summary: Close campaign description: Requires the CAMPAIGNWRITE security role. tags: - Campaigns operationId: closeCampaign security: - OAuth2: - CAMPAIGNWRITE - permanentToken: - CAMPAIGNWRITE parameters: - name: id in: path required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '204': description: Campaign closed successfully '404': description: Campaign not found components: securitySchemes: permanentToken: type: apiKey in: header name: Authorization OAuth2: type: oauth2 flows: clientCredentials: tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token scopes: CAMPAIGNOVERVIEW: '' CAMPAIGNADD: '' CAMPAIGNEDIT: '' CAMPAIGNREMOVE: '' CAMPAIGNWRITE: '' authorizationCode: authorizationUrl: https://{your-auth-url} tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token scopes: CAMPAIGNOVERVIEW: '' CAMPAIGNADD: '' CAMPAIGNEDIT: '' CAMPAIGNREMOVE: '' CAMPAIGNWRITE: ''