Contact

Retrieve a Partner Contact given an ID

get

/partners/{partner_id}/contact/{id}

Authorizations

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

Path parameters

partner_idstringrequired

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.zydon.com.br/api/sales/partners/{partner_id}/contact/{id}' \
  --header 'Authorization: Bearer JWT'

200

404

500

200

{
  "id": "text",
  "partner_id": "text",
  "name": "text",
  "role": "text",
  "phone": "text",
  "email": "text",
  "active": true
}

OK

Update an existing partner contact

put

/partners/{partner_id}/contact/{id}

Authorizations

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

Path parameters

partner_idstringrequired

idstringrequired

Body

idstring

namestringrequired

rolestring

phonestring

emailstring

activeboolean

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.zydon.com.br/api/sales/partners/{partner_id}/contact/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "role": "text",
    "phone": "text",
    "email": "text",
    "active": true
  }'

200

422

500

200

{
  "id": "text",
  "partner_id": "text",
  "name": "text",
  "role": "text",
  "phone": "text",
  "email": "text",
  "active": true
}

Partner Contact updated successfully

Remove a Partner Contact given an ID

delete

/partners/{partner_id}/contact/{id}

Authorizations

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

Path parameters

partner_idstringrequired

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.zydon.com.br/api/sales/partners/{partner_id}/contact/{id}' \
  --header 'Authorization: Bearer JWT'

204

422

500

204

{}

Partner Contact removed successfully

List all contacts given an partner ID

get

/partners/{partner_id}/contact

Authorizations

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

Path parameters

partner_idstringrequired

Query parameters

searchstring · default:

pageinteger · int32 · default: 0

perPageinteger · int32 · default: 25

sortstring · default:

dirstring · default: desc

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.zydon.com.br/api/sales/partners/{partner_id}/contact' \
  --header 'Authorization: Bearer JWT'

200

404

500

200

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "partner_id": "text",
      "name": "text",
      "role": "text",
      "phone": "text",
      "email": "text",
      "active": true
    }
  ]
}

OK

Create a new partner contact

post

/partners/{partner_id}/contact

Authorizations

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

Path parameters

partner_idstringrequired

Body

idstring

namestringrequired

rolestring

phonestring

emailstring

activeboolean

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.zydon.com.br/api/sales/partners/{partner_id}/contact' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "role": "text",
    "phone": "text",
    "email": "text",
    "active": true
  }'

201

422

500

201

{
  "id": "text",
  "partner_id": "text",
  "name": "text",
  "role": "text",
  "phone": "text",
  "email": "text",
  "active": true
}

Partner Contact created successfully