Contatos


As pessoas são a base de qualquer plataforma de automação de marketing. Dentro do RD Station, todos os registros de pessoas são referidos como Contatos, independentemente de serem designados como Leads, possíveis Clientes ou Clientes a partir de uma perspectiva de vendas. O contato vem com um conjunto de campos padrão, como email, primeiro nome e sobrenome. Campos adicionais podem ser adicionados ao contato para ampliar as informações associadas aos registros no sistema. Os campos personalizados podem ser lidos e gravados exatamente como os campos padrão. Outra informação importante é que o campo chave de identificação dos contatos dentro do RD Station é o e-mail deste Contato, que sempre será único.

O principal objeto da API do RD Station é justamente o Contato e, para que seja possível gerir as informações de Contatos em uma conta do RD Station, nós fornecemos alguns endpoints que trazem bastante flexibilidade de integração com a sua solução.


Métodos disponíveis

Returns data about a specific Contact
Request Parameter
uuid Type: String The unique uuid associated to each RD Station Contact.

Response Body Parameters
uuid Type: String The unique uuid associated to each RD Station Contact.
name Type: String Name of the Contact.
email Type: String Email of the Contact.
bio Type: String Notes about the Contact.
website Type: String Website of the Contact.
job_title Type: String Job title of the Contact.
personal_phone Type: String Phone of the Contact.
mobile_phone Type: String Mobile phone of the Contact.
city Type: String City of the Contact.
state Type: String State of the Contact.
country Type: String Country of the Contact.
twitter Type: String Twitter of the Contact.
facebook Type: String Facebook of the Contact.
linkedin Type: String Linkedin of the Contact.
tags Type: Array of Strings Tags of the Contact.

Empty Fields
For empty value fields the following behavior will be adopted:
String and Numbers attributes will not be returned
Array an empty array will be returned []
Boolean Always true or false will be returned
Example:
  {
  "name": "Nome",
  "email": "novo@email.com",
  "job_title": "Developer",
  "website": "http://website.com",
  "mobile": "48 99999-9999",
  "tags": [],
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "cf_custom_field_2": "custom field value2",
  "linkedin": "http://linkedin.com/lead"
}
Returns data about a specific Contact
Request Parameter
e-mail Type: String The primary e-mail associated to a RD Station Contact.

Response Body Parameters
uuid Type: String The unique uuid associated to each RD Station Contact.
name Type: String Name of the Contact.
email Type: String Email of the Contact.
bio Type: String Notes about the Contact.
website Type: String Website of the Contact.
job_title Type: String Job title of the Contact.
personal_phone Type: String Phone of the Contact.
mobile_phone Type: String Mobile phone of the Contact.
city Type: String City of the Contact.
state Type: String State of the Contact.
country Type: String Country of the Contact.
twitter Type: String Twitter of the Contact.
facebook Type: String Facebook of the Contact.
linkedin Type: String Linkedin of the Contact.
tags Type: Array of Strings Tags of the Contact.

Empty Fields
For empty value fields the following behavior will be adopted:
String and Numbers attributes will not be returned
Array an empty array will be returned []
Boolean Always true or false will be returned
Example:
  {
  "name": "Nome",
  "email": "novo@email.com",
  "job_title": "Developer",
  "website": "http://website.com",
  "mobile": "48 99999-9999",
  "tags": [],
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "cf_custom_field_2": "custom field value2",
  "linkedin": "http://linkedin.com/lead"
}
Updates the properties of a Contact.
Request Parameter
uuid Type: String The unique uuid associated to each RD Station Contact.
Request Body Default Parameters
email Type: String Email of the Contact
name Type: String Name of the Contact
job_title Type: String Job title of the Contact
linkedin Type: String Linkedin profile of the Contact
facebook Type: String Facebook profile of the Contact
state Type: String State of the Contact.
country Type: String Country of the Contact.
twitter Type: String Twitter profile of the Contact
personal_phone Type: String Personal phone of the Contact
mobile_phone Type: String Mobile phone number of the Contact
website Type: String Website of the Contact
tags Type: String[] Tags of the Contact

Request Body Custom Field Parameters
When updating the custom fields information, the attribute keys should be sent as the API name of the custom field. The custom field value should also be adequated accordingly to the field's type.

cf_text_field Type: String Custom field of type text.
cf_text_area Type: String Custom field of type text area.
cf_multiple_choice Type: Array of Strings Custom field of type multiple choice.
cf_radio_button Type: String Custom field of type radio button.
cf_number Type: Integer Custom field of type number.
cf_url Type: String Custom field of type URL.
cf_telephone Type: String Custom field of type telephone.
cf_email Type: String Custom field of type email.
cf_checkbox Type: Boolean Custom field of type checkbox.
cf_combobox Type: String Custom field of type combobox.

Response Body Parameters
uuid Type: String The unique uuid associated to each RD Station Contact.
name Type: String Name of the Contact.
email Type: String Email of the Contact.
bio Type: String Notes about the Contact.
website Type: String Website of the Contact.
job_title Type: String Job title of the Contact.
personal_phone Type: String Phone of the Contact.
mobile_phone Type: String Mobile phone of the Contact.
city Type: String City of the Contact.
state Type: String State of the Contact.
country Type: String Country of the Contact.
twitter Type: String Twitter of the Contact.
facebook Type: String Facebook of the Contact.
linkedin Type: String Linkedin of the Contact.
tags Type: Array of Strings Tags of the Contact.

Empty Fields
For empty value fields the following behavior will be adopted:
String and Numbers attributes will not be returned
Array an empty array will be returned []
Boolean Always true or false will be returned
Example:
  {
  "name": "Nome",
  "email": "novo@email.com",
  "job_title": "Developer",
  "website": "http://website.com",
  "mobile": "48 99999-9999",
  "tags": [],
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "cf_custom_field_2": "custom field value2",
  "linkedin": "http://linkedin.com/lead"
}

With an UPSERT like behavior, this endpoint is capable of both updating the properties of a Contact or creating a new Contact. Whatever is used as an identifier cannot appear in the request payload as a field. This will result in a BAD_REQUEST error.
Request Parameter
identifier Type: String The api_identifier of the Contact Field that uniquely identifies the Lead.
Currently only email is supported
value Type: String The value for the given identifier e.g. contact@example.org
Request Body Default Parameters
email Type: String Email of the Contact
name Type: String Name of the Contact
job_title Type: String Job title of the Contact
linkedin Type: String Linkedin profile of the Contact
facebook Type: String Facebook profile of the Contact
state Type: String State of the Contact.
country Type: String Country of the Contact.
twitter Type: String Twitter profile of the Contact
personal_phone Type: String Personal phone of the Contact
mobile_phone Type: String Mobile phone number of the Contact
website Type: String Website of the Contact
tags Type: String[] Tags of the Contact

Request Body Custom Field Parameters
When updating the custom fields information, the attribute keys should be sent as the API name of the custom field. The custom field value should also be adequated accordingly to the field's type.

cf_text_field Type: String Custom field of type text.
cf_text_area Type: String Custom field of type text area.
cf_multiple_choice Type: Array of Strings Custom field of type multiple choice.
cf_radio_button Type: String Custom field of type radio button.
cf_number Type: Integer Custom field of type number.
cf_url Type: String Custom field of type URL.
cf_telephone Type: String Custom field of type telephone.
cf_email Type: String Custom field of type email.
cf_checkbox Type: Boolean Custom field of type checkbox.
cf_combobox Type: String Custom field of type combobox.

Response Body Parameters
uuid Type: String The unique uuid associated to each RD Station Contact.
name Type: String Name of the Contact.
email Type: String Email of the Contact.
bio Type: String Notes about the Contact.
website Type: String Website of the Contact.
job_title Type: String Job title of the Contact.
personal_phone Type: String Phone of the Contact.
mobile_phone Type: String Mobile phone of the Contact.
city Type: String City of the Contact.
state Type: String State of the Contact.
country Type: String Country of the Contact.
twitter Type: String Twitter of the Contact.
facebook Type: String Facebook of the Contact.
linkedin Type: String Linkedin of the Contact.
tags Type: Array of Strings Tags of the Contact.

Empty Fields
For empty value fields the following behavior will be adopted:
String and Numbers attributes will not be returned
Array an empty array will be returned []
Boolean Always true or false will be returned
Example:
  {
  "name": "Nome",
  "email": "novo@email.com",
  "job_title": "Developer",
  "website": "http://website.com",
  "mobile": "48 99999-9999",
  "tags": [],
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "cf_custom_field_2": "custom field value2",
  "linkedin": "http://linkedin.com/lead"
}