Profiles

Retrieve a profile 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

idstringObrigatório

Respostas

200

OK

application/json

idstringOpcional

namestringOpcional

activebooleanOpcional

404

Profile was not found

application/json

500

An internal server error was thrown

application/json

get/profiles/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "active": true
}

Update a existing profile

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

idstringObrigatório

Corpo

application/json

namestringObrigatório

activebooleanObrigatório

Respostas

200

Profile updated successfully

application/json

idstringOpcional

namestringOpcional

activebooleanOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put/profiles/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "active": true
}

{
  "id": "text",
  "name": "text",
  "active": true
}

Remove an existing profile

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

idstringObrigatório

Respostas

204

Profile removed successfully

application/json

idstringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete/profiles/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text"
}

List profiles

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: ""

dirstringOpcionalDefault: asc

Respostas

200

OK

application/json

currentPageinteger · int32Opcional

perPageinteger · int32Opcional

totalinteger · int64Opcional

404

Profile was not found

application/json

500

An internal server error was thrown

application/json

get/profiles

HTTPcURLJavaScriptPython

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

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "active": true,
      "partner_size": 1
    }
  ]
}

Create a new profile

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

idstringOpcional

namestringObrigatório

activebooleanObrigatório

Respostas

200

Profile created successfully

application/json

idstringOpcional

namestringOpcional

activebooleanOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/profiles

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "active": true
}

{
  "id": "text",
  "name": "text",
  "active": true
}