Contact

Retrieve a Partner Contact 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

partner_idstringObrigatório

idstringObrigatório

Respostas

200

OK

application/json

404

Partner Contact was not found

application/json

500

An internal server error was thrown

application/json

get

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

HTTPcURLJavaScriptPython

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

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

Update an existing partner contact

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

partner_idstringObrigatório

idstringObrigatório

Corpo

application/json

idstringOpcional

namestringObrigatório

rolestringOpcional

phonestringOpcional

emailstringOpcional

activebooleanOpcional

Respostas

200

Partner Contact updated successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put

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

HTTPcURLJavaScriptPython

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

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

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

Remove a Partner Contact 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

partner_idstringObrigatório

idstringObrigatório

Respostas

204

Partner Contact removed successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete

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

HTTPcURLJavaScriptPython

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

{}

List all contacts given an partner 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

partner_idstringObrigatório

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: desc

Respostas

200

OK

application/json

404

Partner was not found

application/json

500

An internal server error was thrown

application/json

get

/partners/{partner_id}/contact

HTTPcURLJavaScriptPython

GET /api/sales/partners/{partner_id}/contact HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create a new partner contact

post

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

partner_idstringObrigatório

Corpo

application/json

idstringOpcional

namestringObrigatório

rolestringOpcional

phonestringOpcional

emailstringOpcional

activebooleanOpcional

Respostas

201

Partner Contact created successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post

/partners/{partner_id}/contact

HTTPcURLJavaScriptPython

POST /api/sales/partners/{partner_id}/contact HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

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

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