GET /v1/contacts?page=:page
Listar contatos

Erros

Code Description
404 Not found
422 Could not save the entity
429 Requests limit exceeded for api_token
500 Internal Server Error

Parâmentros

Nome parâmetro Descrição
api_token
requerido

Pode ser adiquirido acessando app.reev.co -> Configurações -> Integrações

Validations:

  • Must be a String

page
requerido

Validations:

  • Must be a Integer

user_id
opcional

Pesquisa de contatos de um usuário específico

Validations:

  • Must be a Integer

search_term
opcional

Pesquisa de contatos pelo nome, empresa ou email

Validations:

  • Must be a String


GET /v1/contacts/:id
Obter detalhes do contato

Parâmentros

Nome parâmetro Descrição
api_token
requerido

Pode ser adiquirido acessando app.reev.co -> Configurações -> Integrações

Validations:

  • Must be a String

id
requerido

Validations:

  • Must be a Integer


POST /v1/contacts
Criar contato

Parâmentros

Nome parâmetro Descrição
api_token
requerido

Pode ser adiquirido acessando app.reev.co -> Configurações -> Integrações

Validations:

  • Must be a String

carousel
opcional

Validations:

  • Must be one of: true, false.

first_name
requerido

Validations:

  • Must be a String

last_name
opcional

Validations:

  • Must be a String

email
requerido

Validations:

  • Must be a String

business
opcional

Validations:

  • Must be a String

position
opcional

Validations:

  • Must be a String

telephone
opcional

Validations:

  • Must be a String

cellphone
opcional

Validations:

  • Must be a String

address
opcional

Validations:

  • Must be a String

url
opcional

Validations:

  • Must be a String

linkedin
opcional

Validations:

  • Must be a String

variable1
opcional

Validations:

  • Must be a String

variable2
opcional

Validations:

  • Must be a String

variable3
opcional

Validations:

  • Must be a String

stage
opcional

Valores possíveis: smart_lead, prospect, lead, mql, sql, opportunity, client, lost

Validations:

  • Must be a String

custom_fields
opcional

Ex: [ { “field”: “Idade”, “value”: “24” } ]

Validations:

  • Must be an Array of nested elements

custom_fields[field]
opcional

Validations:

  • Must be a String

custom_fields[value]
opcional

Validations:

  • Must be a String

tags
opcional

Ex: [1, 3, 5, 6]

Validations:

  • Must be an array of any type

contact_group_id
opcional

Validations:

  • Must be a Integer


PUT /v1/contacts/:id
Atualizar contato

Parâmentros

Nome parâmetro Descrição
api_token
requerido

Pode ser adiquirido acessando app.reev.co -> Configurações -> Integrações

Validations:

  • Must be a String

carousel
opcional

Validations:

  • Must be one of: true, false.

first_name
requerido

Validations:

  • Must be a String

last_name
opcional

Validations:

  • Must be a String

email
requerido

Validations:

  • Must be a String

business
requerido

Validations:

  • Must be a String

position
opcional

Validations:

  • Must be a String

telephone
opcional

Validations:

  • Must be a String

cellphone
opcional

Validations:

  • Must be a String

address
opcional

Validations:

  • Must be a String

url
opcional

Validations:

  • Must be a String

linkedin
opcional

Validations:

  • Must be a String

variable1
opcional

Validations:

  • Must be a String

variable2
opcional

Validations:

  • Must be a String

variable3
opcional

Validations:

  • Must be a String

user_id
opcional

Id do usuário

Validations:

  • Must be a Integer

stage
opcional

Valores possíveis: smart_lead, prospect, lead, mql, sql, opportunity, client, lost

Validations:

  • Must be a String

custom_fields
opcional

Ex: [ { “field”: “Idade”, “value”: “24” } ]

Validations:

  • Must be an Array of nested elements

custom_fields[field]
opcional

Validations:

  • Must be a String

custom_fields[value]
opcional

Validations:

  • Must be a String

tags
opcional

Ex: [1, 3, 5, 6]

Validations:

  • Must be an array of any type

contact_group_id
opcional

Validations:

  • Must be a Integer


GET /v1/contacts/:id/events?page=:page
Listar eventos do contato

Parâmentros

Nome parâmetro Descrição
api_token
requerido

Pode ser adiquirido acessando app.reev.co -> Configurações -> Integrações

Validations:

  • Must be a String

id
requerido

Validations:

  • Must be a Integer

page
requerido

Validations:

  • Must be a Integer


DELETE /v1/contacts/:id
Remover contato

Parâmentros

Nome parâmetro Descrição
api_token
requerido

Pode ser adiquirido acessando app.reev.co -> Configurações -> Integrações

Validations:

  • Must be a String

id
requerido

Validations:

  • Must be a Integer