POST /work-requests

1 min

POST

https://api.cmp.optimizely.com/v3/work-requests

Experimental Create a work request.

Body Parameters

bodyWorkRequestCreateRequestrequired

Example

{
  "template_id": "5c89aebe611eca11302420af",
  "assignees": [
    "74ba987cc9251689abc123"
  ],
  "form_fields": [
    {
      "identifier": "title",
      "type": "text",
      "values": [
        "Some title"
      ]
    },
    {
      "identifier": "brief",
      "type": "brief",
      "values": [
        {
          "type": "attachment_brief",
          "value": {
            "key": "10d5c89aebe611eca11302420ac80002",
            "name": "Attachment"
          }
        }
      ]
    },
    {
      "identifier": "630c486a90546926f034ea28",
      "type": "richtext",
      "values": [
        "<b>rich</b> text"
      ]
    },
    {
      "identifier": "630c479690546926f034ea13",
      "type": "label",
      "values": [
        "630c479690546926f034ea15"
      ]
    },
    {
      "identifier": "630c47be90546926f034ea17",
      "type": "dropdown",
      "values": [
        "630c47be90546926f034ea18"
      ]
    },
    {
      "identifier": "630c482b90546926f034ea22",
      "type": "simple_number",
      "values": [
        1234.345678
      ]
    },
    {
      "identifier": "630c484b90546926f034ea23",
      "type": "percentage_number",
      "values": [
        23
      ]
    },
    {
      "identifier": "630c481b90546926f034ea21",
      "type": "currency_number",
      "values": [
        123.56
      ]
    },
    {
      "identifier": "630c485e90546926f034ea24",
      "type": "checkbox",
      "values": [
        "630c485e90546926f034ea25"
      ]
    },
    {
      "identifier": "630c47d290546926f034ea1b",
      "type": "radio_button",
      "values": [
        "630c47d290546926f034ea1c"
      ]
    },
    {
      "identifier": "creative_assets",
      "type": "file",
      "values": [
        {
          "key": "creative-asset-key-1",
          "name": "Creative Asset 1"
        },
        {
          "key": "creative-asset-key-2",
          "name": "Creative Asset 2"
        }
      ]
    },
    {
      "identifier": "due_date",
      "type": "date",
      "values": [
        "2022-02-20T12:02:03.000000Z"
      ]
    },
    {
      "identifier": "media_links",
      "type": "text_area",
      "values": [
        "some text\nmore text"
      ]
    }
  ]
}

Description

Payload to create a work request

template_idstringrequired
Example
1265ca474ba987cc925164aa7
Description
The template on which the work request should be created
assigneesstring[]
Description
List of assigned users to the work request
form_fieldsTextTypeFormFieldRequest[]required
Description
Form fields from the work request template to populate in the work request. NOTE You must provide values for all the required form fields.
- BaseFormFieldRequest
  - identifierstringrequired
    Example
    brief
    Description
    Identifier of the form field collected from the template form field
  - typestringrequired
    Example
    brief
    Description
    Type of the form field
  - valuesobject[]required
    Description
    Values for the form field to populate in the work request
- object
  - valuesstring[]

Responses

201Created work request

WorkRequestResponse
- idstringrequired
  Example
  5fe4925ef8a9378056bf4e37
  Description
  Unique identifier of the work request
- templateobjectrequired
  Description
  The template, based on the work request that was created
  - idstringrequired
    Example
    1265ca474ba987cc925164aa7
    Description
    Unique identifier of the template
  - titlestringrequired
    Example
    Sample template title
    Description
    Title of the template
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/templates/9119a313057e401189407116fcd3aa24
      Description
      URL of the template
- reference_idstringrequired
  Example
  WRQ-23
  Description
  Reference identifier of the work request
- assigneesobject[]required
  Description
  List of assigned users to the work request
  - idstringrequired
    Example
    6asdcnfnfdsfdsfd54sgfd54sf
    Description
    Unique identifier of the assignee
  - typestring<user | team>required
    Example
    user
    Description
    Type of the assignee
    Allowed
    userteam
  - full_namestringrequired
    Example
    John Doe
    Description
    Full name of the assignee
  - image_urlstringrequired
    Example
    https://images.cmp.optimizely.com/6a485f72ba424f9397c71ddf0cfb8f59
    Description
    URL of the profile picture of the assignee. null if the assignee has not provided an image
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/users/6asdcnfnfdsfdsfd54sgfd54sf
      Description
      URL of the assigned user
- statusstring<Accepted | Declined | Submitted | Completed>required
  Example
  Accepted
  Description
  Current status of the work request
  Allowed
  AcceptedDeclinedSubmittedCompleted
- prioritystring<Low | Medium | High>required
  Example
  Medium
  Description
  Priority of the work request
  Allowed
  LowMediumHigh
- created_byobjectrequired
  Description
  Creator of the work request
  - idstringrequired
    Example
    6asdcnfnfdsfdsfd54sgfd54sf
    Description
    Unique identifier of the creator of the work request
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/users/6asdcnfnfdsfdsfd54sgfd54sf
      Description
      URL of the creator
- created_atstring<date-time>required
  Example
  2022-04-30T06:00:00.000Z
  Description
  Date and time on which the work request was created, in ISO 8601 UTC format (2022-04-30T06:00
  .000Z)
  Format
  date-time
- modified_atstring<date-time>required
  Example
  2022-04-30T08:00:00.000Z
  Description
  Date and time on which the work request was last modified, in ISO 8601 UTC format (2022-04-30T08:00
  .000Z)
  Format
  date-time
- form_fieldsTextTypeFormFieldResponse[]required
  Description
  Populated form fields following the template
  - BaseFormFieldResponse
    - identifierstringrequired
      Example
      brief
      Description
      Identifier of the form field collected from the template form field
    - typestringrequired
      Example
      brief
      Description
      Type of the form field
    - valuesobject[]required
      Description
      Values of the form field
    - is_protectedboolean
      Description
      True when this form field is read-only and only organization admins can modify it. Absent or false for editable fields.
  - object
    - valuesstring[]
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37
    Description
    URL of the work request
  - commentsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/comments
    Description
    URL to create or get work request comments
  - attachmentsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/attachments
    Description
    URL to add attachments to work request
  - campaignsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/campaigns
    Description
    URL to create a campaign from the work request
  - tasksstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/tasks
    Description
    URL to create a task from the work request
  - creative_assetsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/creative-assets
    Description
    URL to add creative assets to the work request
  - related_resourcesstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/related-resources
    Description
    URL to get related resources

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

422Unprocessable entity error

Error
Example
```
{
  "message": "Resource cannot be processed"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request POST \
     --url https://api.cmp.optimizely.com/v3/work-requests \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "template_id": "1265ca474ba987cc925164aa7",
     "form_fields": {
     "identifier": "brief",
     "type": "brief",
     "values": []
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "template_id": "1265ca474ba987cc925164aa7",
   "form_fields": {
      "identifier": "brief",
      "type": "brief",
      "values": []
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/work-requests", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/work-requests")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "template_id": "1265ca474ba987cc925164aa7",
   "form_fields": {
      "identifier": "brief",
      "type": "brief",
      "values": []
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/work-requests"

payload = json.dumps({
   "template_id": "1265ca474ba987cc925164aa7",
   "form_fields": {
      "identifier": "brief",
      "type": "brief",
      "values": []
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Created work request
{
  "id": "5fe4925ef8a9378056bf4e37",
  "template": {
    "id": "1265ca474ba987cc925164aa7",
    "title": "Sample template title",
    "links": {
      "self": "https://api.cmp.optimizely.com/v3/templates/9119a313057e401189407116fcd3aa24"
    }
  },
  "reference_id": "WRQ-23",
  "assignees": [
    {
      "id": "6asdcnfnfdsfdsfd54sgfd54sf",
      "type": "user",
      "full_name": "John Doe",
      "image_url": "https://images.cmp.optimizely.com/6a485f72ba424f9397c71ddf0cfb8f59",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/users/6asdcnfnfdsfdsfd54sgfd54sf"
      }
    }
  ],
  "status": "Accepted",
  "priority": "Medium",
  "created_by": {
    "id": "6asdcnfnfdsfdsfd54sgfd54sf",
    "links": {
      "self": "https://api.cmp.optimizely.com/v3/users/6asdcnfnfdsfdsfd54sgfd54sf"
    }
  },
  "created_at": "2022-04-30T06:00:00.000Z",
  "modified_at": "2022-04-30T08:00:00.000Z",
  "form_fields": {},
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37",
    "comments": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/comments",
    "attachments": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/attachments",
    "campaigns": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/campaigns",
    "tasks": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/tasks",
    "creative_assets": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/creative-assets",
    "related_resources": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/related-resources"
  }
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

422

// Unprocessable entity error
{
  "message": "Not found",
  "errors": ""
}