Delete 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

Python

import requests
response = requests.delete(
    "https://journeys-api.50skills.app/v1/company/lists/{short_id}/",
)
print(response.json())             

JavaScript