Profiles

Retrieve a profile given an ID

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
application/json
get
GET /api/sales/profiles/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "name": "text",
  "active": true
}

Update a existing profile

put
Autorizações
Parâmetros de rota
idstringObrigatório
Corpo
namestringObrigatório
activebooleanObrigatório
Respostas
200
Profile updated successfully
application/json
put
PUT /api/sales/profiles/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
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
Parâmetros de rota
idstringObrigatório
Respostas
204
Profile removed successfully
application/json
delete
DELETE /api/sales/profiles/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text"
}

List profiles

get
Autorizações
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: ""
dirstringOpcionalDefault: asc
Respostas
200
OK
application/json
get
GET /api/sales/profiles HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "active": true,
      "partner_size": 1
    }
  ]
}

Create a new profile

post
Autorizações
Corpo
idstringOpcional
namestringObrigatório
activebooleanObrigatório
Respostas
200
Profile created successfully
application/json
post
POST /api/sales/profiles HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 41

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