Journeys
  • Introduction
  • Getting access
  • Authentication
  • Terminology
  • API reference
    • Authorization
      • Authorize
    • Company
      • Retrieve company
      • Update company
    • Company lists
      • Retrieve company list
      • List company lists
      • Create company list
      • Update company list
      • Delete company list
    • Journeys
      • List journeys
      • Retrieve journey
      • Delete journey
      • Edit journey
    • Journey actions
      • List journey actions
      • Retrieve journey action
      • Delete journey action
    • Traveller journeys
      • List traveller journeys
      • Retrieve traveller journey
      • Retrieve actions
      • Start traveller journey
      • Create traveller journey
      • Delete traveller journey
    • Traveller journey actions
      • List journey traveller actions
      • Retrieve journey traveller action
    • Users
      • Invite
      • List users
      • Create user
      • Retrieve user
      • Delete user
      • Update user
  • Specification
Powered by GitBook
On this page
  1. API reference
  2. Company lists

Create company list

PreviousList company listsNextUpdate company list

Last updated 1 year ago


Request samples

{
   "name":"Issue types",
   "source":"Jira",
   "options":[
      {
         "value":"10003",
         "label":"Service request"
      },
      {
         "value":"10000",
         "label":"Epic"
      },
      {
         "value":"10007",
         "label":"System problem"
      }
   ]
}
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

{
   "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
}
{
   "name":[
      "This field is required."
   ]
}

Create company list

post

Create a new company list

Authorizations
Body
idstringRead-onlyRequired
short_idstringRead-onlyRequired
namestring ยท max: 255Required
sourcestring | nullableOptional
num_optionsstringRead-onlyRequired
Responses
201Success
application/json
400Error
application/json
401
Unauthorized
{
  "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
}