👤 Contatos

BlockContact

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/blockContact

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

contactIdnumberOpcional

blockedbooleanOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/blockContact

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/blockContact HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "contactId": 1,
  "blocked": true
}

200

Successful response

CreateContact

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/createContact

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

namestringOpcional

numberstringOpcional

emailstringOpcional

cpfstringOpcional

firstNamestringOpcional

lastNamestringOpcional

businessNamestringOpcional

birthdayDatestringOpcional

externalKeystringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/createContact

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/createContact HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "name": "Nome",
  "number": "5515998566622",
  "email": "[e-mail]",
  "cpf": "012.345.678.91",
  "firstName": "Nome Principal",
  "lastName": "Sobrenome",
  "businessName": "Empresa",
  "birthdayDate": "01/01/1990",
  "externalKey": "{{SecretKey}}"
}

200

Successful response

GetContactExtraInfo

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/getContactExtraInfo

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

contactIdintegerOpcional

ID do contato

Example: 1

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/getContactExtraInfo

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/getContactExtraInfo HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

SearchContacts

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/contacts/search

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

searchParamstringOpcional

pagenumberOpcional

limitnumberOpcional

tagIdnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/contacts/search

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/contacts/search HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "searchParam": "",
  "page": 1,
  "limit": 40,
  "tagId": 1
}

200

Successful response

ShowContact

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/showcontact

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

numberstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/showcontact

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/showcontact HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "number": "5515998566622"
}

200

Successful response

UpdateContact

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/updateContact

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

namestringOpcional

numberstringOpcional

emailstringOpcional

cpfstringOpcional

firstNamestringOpcional

lastNamestringOpcional

businessNamestringOpcional

birthdayDatestringOpcional

kanbannumberOpcional

externalKeystringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updateContact

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updateContact HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "name": "Nome",
  "number": "5515998566622",
  "email": "[e-mail]",
  "cpf": "012.345.678.91",
  "firstName": "Nome Principal",
  "lastName": "Sobrenome",
  "businessName": "Empresa",
  "birthdayDate": "01/01/1990",
  "kanban": 2,
  "externalKey": "ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK"
}

200

Successful response

UpdateContactExtraInfo

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/updateContactExtraInfo

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

contactIdnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updateContactExtraInfo

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updateContactExtraInfo HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "contactId": 1,
  "extraInfo": [
    {
      "name": "Campo Personalizado 1",
      "value": "Valor do campo 1"
    },
    {
      "name": "Campo Personalizado 2",
      "value": "Valor do campo 2"
    }
  ]
}

200

Successful response

UpdateContactKanban

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/updateContactKanban

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

contactIdnumberOpcional

kanbannumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updateContactKanban

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updateContactKanban HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "contactId": 1,
  "kanban": 2
}

200

Successful response

UpdateContactWallet

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/updateContactWallet

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

contactIdnumberOpcional

walletIdnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updateContactWallet

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updateContactWallet HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "contactId": 1,
  "walletId": 2
}

200

Successful response