Create a stage

POSThttp://localhost:4000/api/stages/create

Adds a stage to your pipeline, at the end of its category. An organization can have up to 10 stages.

Your API key needs the stages.MANAGE permission.

Body Params

namestringrequired

Stage name.

categoryenumrequired

The part of the pipeline this stage belongs to.

categoryOrderintegerrequired

Position of the category in the pipeline.

iconstring

Icon name.

colorstring

Color, for example #0c68e9.

nameTranslationsobject

Stage name per language code.

Responses

200Successful response.

400The request is not valid.

401The API key is missing, invalid, expired or disabled.

403The API key does not have the permission this endpoint needs.

Language

Credentials

Bearer

Kept in this browser tab and sent only to the Estactics API. Requests act on your real data.

cURL Request

curl --request POST \
  --url http://localhost:4000/api/stages/create \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Viewing booked","category":"ACTIVE","categoryOrder":2,"color":"#0c68e9"}'

Response

Click Try It! to send a request and see the response here, or choose an example: