Update company list

Edit company list

patch

Edit a company list

Authorizations

tokenAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

short_idstringRequired

Body

application/json

idstringRead-onlyOptional

short_idstringRead-onlyOptional

namestring · max: 255Optional

sourcestring | nullableOptional

num_optionsstringRead-onlyOptional

Responses

200Success

application/json

401

Unauthorized

404

Not found

patch

v1/company/lists/{short_id}/

Python

import requests
response = requests.patch(
    "https://journeys-api.50skills.app/v1/company/lists/jkG26kGX/",
    json={
        "name": "New list name"
    }
)
print(response.json())
                    

{
  "id": "jkG26kGX",
  "shortId": "jkG26kGX",
  "name": "New list name",
  "source": null,
  "options": [
    {
      "shortId": "8oz34Ryp",
      "value": "1",
      "label": "New option one",
      "order": 0
    },
    {
      "shortId": "AYGpZNzo",
      "value": "2",
      "label": "New option two",
      "order": 1
    }
  ],
  "numOptions": 2
}

Request samples

Application/JSON

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

Python

Response samples

200

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