Create company list

Create company list

post

Create a new company list

Authorizations

Body

idstringread-onlyrequired

short_idstringread-onlyrequired

namestring · max: 255required

sourcestring | nullableoptional

optionsobject[]optional

num_optionsstringread-onlyrequired

Responses

application/json

application/json

201

400

401

201

{
  "id": "rbKVWezO",
  "shortId": "rbKVWezO",
  "name": "List two",
  "source": null,
  "options": [
    {
      "shortId": "mrzWkVzj",
      "value": "1",
      "label": "Option one",
      "order": 0
    },
    {
      "shortId": "mrzWkVzj",
      "value": "2",
      "label": "Option two",
      "order": 1
    }
  ],
  "numOptions": 2
}

---

Request samples

Application/JSON

{
   "name":"Issue types",
   "source":"Jira",
   "options":[
      {
         "value":"10003",
         "label":"Service request"
      },
      {
         "value":"10000",
         "label":"Epic"
      },
      {
         "value":"10007",
         "label":"System problem"
      }
   ]
}

Python

import requests
response = requests.post(
    "https://journeys-api.50skills.app/v1/company/lists/",
    json={
        "name": "Issue types",
        "source": "Jira",
        "options": [
            {
                "value":"10003",
                "label":"Service request"
            },
            {
                 "value":"10000",
                 "label":"Epic"
            },
            {
                 "value":"10007",
                 "label":"System problem"
            }
        ],
    }
)
print(response.json())               

Response samples

201 (Created)

{
   "id":"AOse1MyX",
   "shortId":"AOse1MyX",
   "name":"Issue types",
   "source":"Jira",
   "options":[
      {
         "shortId":"mrzWmkKj",
         "value":"10003",
         "label":"Service request",
         "order":0
      },
      {
         "shortId":"MzKmA3K8",
         "value":"10000",
         "label":"Epic",
         "order":1
      },
      {
         "shortId":"wMyvRayZ",
         "value":"10007",
         "label":"System problem",
         "order":2
      }
   ],
   "numOptions":3
}

400

{
   "name":[
      "This field is required."
   ]
}