Etapas do funil — API Zyron Connect Suite

Getting started

Module

Pipeline stages

Manage the pipeline columns used by the CRM.

GET/stages/stages POST/stages/stages PATCH/stages/:id/stages/:id DELETE/stages/:id/stages/:id

GET/stagesScope: readOfficial + Basic

List stages ordered by position.

Use it before moving contacts to discover valid stage IDs.

Path parameters

No additional parameters.

Query parameters

No additional parameters.

Body fields

This endpoint does not receive a JSON body.

Ready examples

curl -X GET "https://connect.zyronstack.com/api/v1/stages" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Responses

200	Stages returned.

Response example

{
  "data": [
    {
      "id": "<STAGE_ID>",
      "name": "Negociando",
      "position": 2,
      "color": "#D9982F",
      "auto_kind": null,
      "created_at": "2026-06-15T12:30:00.000Z"
    }
  ]
}

POST/stagesScope: writeOfficial + Basic

Create a new stage.

The new stage is placed after the current last position.

Path parameters

No additional parameters.

Query parameters

No additional parameters.

Body fields

Field	Type	Description
`name`required	string	Stage name, up to 40 characters.
`color`optional	string	Hex color. Defaults to #5b9bd9.

Ready examples

curl -X POST "https://connect.zyronstack.com/api/v1/stages" \
  -H "Authorization: Bearer SUA_CHAVE_API" \
  -H "content-type: application/json" \
  -d '{
  "name": "Negociando",
  "color": "#D9982F"
}'

Responses

201	Stage created.
422	Missing name.

Response example

{
  "data": {
    "id": "<STAGE_ID>",
    "name": "Negociando",
    "position": 2,
    "color": "#D9982F",
    "auto_kind": null,
    "created_at": "2026-06-15T12:30:00.000Z"
  }
}

PATCH/stages/:idScope: writeOfficial + Basic

Update name, color or position.

Send at least one field. Position is normalized to a non-negative integer.

Path parameters

Field	Type	Description
`id`required	uuid	Stage ID.

Query parameters

No additional parameters.

Body fields

Field	Type	Description
`name`optional	string	New stage name.
`color`optional	string	New hex color.
`position`optional	number	New pipeline position.

Ready examples

curl -X PATCH "https://connect.zyronstack.com/api/v1/stages/<STAGE_ID>" \
  -H "Authorization: Bearer SUA_CHAVE_API" \
  -H "content-type: application/json" \
  -d '{
  "name": "Proposta enviada",
  "color": "#5B9BD9",
  "position": 3
}'

Responses

200	Stage updated.
422	No field sent or invalid name.

Response example

{
  "data": {
    "id": "<STAGE_ID>",
    "name": "Proposta enviada",
    "position": 3,
    "color": "#5B9BD9",
    "auto_kind": null,
    "created_at": "2026-06-15T12:30:00.000Z"
  }
}

DELETE/stages/:idScope: writeOfficial + Basic

Delete a pipeline stage.

The API keeps at least one stage. Contacts from the deleted stage fall back to automatic derivation.

Path parameters

Field	Type	Description
`id`required	uuid	Stage ID.

Query parameters

No additional parameters.

Body fields

This endpoint does not receive a JSON body.

Ready examples

curl -X DELETE "https://connect.zyronstack.com/api/v1/stages/<STAGE_ID>" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Responses

200	Stage deleted.
422	Attempt to delete the last stage.

Response example

{
  "deleted": true
}