Profiles

Retrieve a profile given an ID

GEThttps://api.zydon.com.br/api/sales/profiles/{id}

Authorization

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

Path parameters

id*string

Response

200404500

OK

Body

application/json

idstring

namestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/profiles/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

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

Update a existing profile

PUThttps://api.zydon.com.br/api/sales/profiles/{id}

Authorization

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

Path parameters

id*string

Body

application/json

name*string

Response

200422500

Profile updated successfully

Body

application/json

idstring

namestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/profiles/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200422500

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

Remove an existing profile

DELETEhttps://api.zydon.com.br/api/sales/profiles/{id}

Authorization

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

Path parameters

id*string

Response

204422500

Profile removed successfully

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/profiles/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

204422500

{
  "id": "text"
}

List profiles

GEThttps://api.zydon.com.br/api/sales/profiles

Authorization

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

Query parameters

Response

200404500

OK

Body

application/json

currentPageinteger (int32)

perPageinteger (int32)

totalinteger (int64)

itemsarray of ListProfileResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/profiles', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "partner_size": 0
    }
  ]
}

Create a new profile

POSThttps://api.zydon.com.br/api/sales/profiles

Authorization

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

Body

application/json

idstring

name*string

Response

200422500

Profile created successfully

Body

application/json

idstring

namestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/profiles', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200422500

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