Status

Retrieve an existing status given an ID

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstring · uuidObrigatório

Respostas

200

Status retrieved

*/*

400

Cannot retrieve status

*/*

500

An internal server error was thrown

*/*

get

/status/{id}

HTTPcURLJavaScriptPython

GET /api/sales/status/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "title": "text",
  "sub_title": "text",
  "type": "PENDING",
  "can_edit_by_customer": true,
  "can_edit_by_api": true,
  "show_in_portal": true,
  "background_color": "text",
  "font_color": "text",
  "relations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "destiny": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "title": "text"
      },
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-12-15T17:36:57.739Z",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_at": "2025-12-15T17:36:57.739Z"
    }
  ],
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-15T17:36:57.739Z",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "2025-12-15T17:36:57.739Z"
}

Update an existing status given an ID

put

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstring · uuidObrigatório

Corpo

application/json

titlestringObrigatório

sub_titlestringObrigatório

typestring · enumObrigatórioValores possíveis:

can_edit_by_customerbooleanObrigatório

can_edit_by_apibooleanObrigatório

show_in_portalbooleanObrigatório

background_colorstringObrigatório

font_colorstringObrigatório

Respostas

200

Status updated

*/*

400

Cannot update status

*/*

500

An internal server error was thrown

*/*

put

/status/{id}

HTTPcURLJavaScriptPython

PUT /api/sales/status/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 316

{
  "title": "text",
  "sub_title": "text",
  "type": "PENDING",
  "can_edit_by_customer": true,
  "can_edit_by_api": true,
  "show_in_portal": true,
  "background_color": "text",
  "font_color": "text",
  "relations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "destiny": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "title": "text"
      }
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "title": "text",
  "sub_title": "text",
  "type": "PENDING",
  "can_edit_by_customer": true,
  "can_edit_by_api": true,
  "show_in_portal": true,
  "background_color": "text",
  "font_color": "text",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-15T17:36:57.739Z",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "2025-12-15T17:36:57.739Z"
}

Remove an existing status given an ID

delete

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstring · uuidObrigatório

Respostas

200

Status removed

*/*

400

Cannot remove status

*/*

500

An internal server error was thrown

*/*

delete

/status/{id}

HTTPcURLJavaScriptPython

DELETE /api/sales/status/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Retrieve a page of status

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: id

dirstringOpcionalDefault: asc

Respostas

200

Status listed

*/*

400

Cannot list status

*/*

500

An internal server error was thrown

*/*

get

/status

HTTPcURLJavaScriptPython

GET /api/sales/status HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "title": "text",
      "sub_title": "text",
      "type": "PENDING",
      "can_edit_by_customer": true,
      "can_edit_by_api": true,
      "show_in_portal": true,
      "background_color": "text",
      "font_color": "text",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-12-15T17:36:57.739Z",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_at": "2025-12-15T17:36:57.739Z"
    }
  ]
}

Create a new status

post

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

namestringObrigatório

titlestringObrigatório

sub_titlestringObrigatório

typestring · enumObrigatórioValores possíveis:

can_edit_by_customerbooleanObrigatório

can_edit_by_apibooleanObrigatório

show_in_portalbooleanObrigatório

background_colorstringObrigatório

font_colorstringObrigatório

Respostas

200

Status created

*/*

400

Cannot create status

*/*

500

An internal server error was thrown

*/*

post

/status

HTTPcURLJavaScriptPython

POST /api/sales/status HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "name": "text",
  "title": "text",
  "sub_title": "text",
  "type": "PENDING",
  "can_edit_by_customer": true,
  "can_edit_by_api": true,
  "show_in_portal": true,
  "background_color": "text",
  "font_color": "text",
  "relations": [
    {
      "destiny": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "title": "text"
      }
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "title": "text",
  "sub_title": "text",
  "type": "PENDING",
  "can_edit_by_customer": true,
  "can_edit_by_api": true,
  "show_in_portal": true,
  "background_color": "text",
  "font_color": "text",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-12-15T17:36:57.739Z",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "2025-12-15T17:36:57.739Z"
}