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
Field Type Description
uuid String The unique uuid associated to each RD Station Contact.

Response Body Parameters
Field Type Description
uuid String The unique uuid associated to each RD Station Contact.
name String Name of the Contact.
email String Email of the Contact.
bio String Notes about the Contact.
website String Website of the Contact.
job_title String Job title of the Contact.
personal_phone String Phone of the Contact.
mobile_phone String Mobile phone of the Contact.
city String City of the Contact.
state String State of the Contact.
country String Country of the Contact.
twitter String Twitter of the Contact.
facebook String Facebook of the Contact.
linkedin String Linkedin of the Contact.
tags ArrayStrings Tags of the Contact.
extra_emails ArrayStrings Extra emails of the Contact.
legal_bases ArrayObjects Legal Bases of the Contact.

Empty Fields

For empty value fields the following behavior will be adopted:

Type Description
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": "RD Station Developer",
  "email": "contact@example.com",
  "job_title": "Developer",
  "bio": "This documentation explains the RD Station API.",
  "website": "https://developers.rdstation.com/",
  "linkedin": "rd_station",
  "personal_phone": "+55 48 3037-3600",
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "tags": ["developer", "rdstation", "api"],
  "extra_emails": ["contact2@example.com"],
  "cf_custom_field_2": "custom field value2",
  "legal_bases": [
    {
      "category": "data_processing",
      "type": "pre_existent_contract",
      "status": "granted"
    },
    {
      "category": "communications",
      "type": "consent",
      "status": "granted"
    }
  ]
}
Returns data about a specific Contact
Request Parameter
Field Type Description
e-mail String The primary e-mail associated to a RD Station Contact.

Response Body Parameters
Field Type Description
uuid String The unique uuid associated to each RD Station Contact.
name String Name of the Contact.
email String Email of the Contact.
bio String Notes about the Contact.
website String Website of the Contact.
job_title String Job title of the Contact.
personal_phone String Phone of the Contact.
mobile_phone String Mobile phone of the Contact.
city String City of the Contact.
state String State of the Contact.
country String Country of the Contact.
twitter String Twitter of the Contact.
facebook String Facebook of the Contact.
linkedin String Linkedin of the Contact.
tags ArrayStrings Tags of the Contact.
extra_emails ArrayStrings Extra emails of the Contact.
legal_bases ArrayObjects Legal Bases of the Contact.

Empty Fields

For empty value fields the following behavior will be adopted:

Type Description
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": "RD Station Developer",
  "email": "contact@example.com",
  "job_title": "Developer",
  "bio": "This documentation explains the RD Station API.",
  "website": "https://developers.rdstation.com/",
  "linkedin": "rd_station",
  "personal_phone": "+55 48 3037-3600",
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "tags": ["developer", "rdstation", "api"],
  "extra_emails": ["contact2@example.com"],
  "cf_custom_field_2": "custom field value2",
  "legal_bases": [
    {
      "category": "data_processing",
      "type": "pre_existent_contract",
      "status": "granted"
    },
    {
      "category": "communications",
      "type": "consent",
      "status": "granted"
    }
  ]
}
Updates the properties of a Contact.
Request Parameter
Field Type Description
uuid String The unique uuid associated to each RD Station Contact.

Request Body Default Parameters
Field Type Description
email String Email of the Contact
name String Name of the Contact
bio String Notes about the Contact.
job_title String Job title of the Contact
linkedin String Linkedin profile of the Contact
facebook String Facebook profile of the Contact
city String City of the Contact.
state String State of the Contact.
country String Country of the Contact.
twitter String Twitter profile of the Contact
personal_phone String Personal phone of the Contact
mobile_phone String Mobile phone number of the Contact
website String Website of the Contact
tags ArrayStrings Tags of the Contact
legal_bases ArrayObjects Legal Bases 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.

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

Response Body Parameters
Field Type Description
uuid String The unique uuid associated to each RD Station Contact.
name String Name of the Contact.
email String Email of the Contact.
bio String Notes about the Contact.
website String Website of the Contact.
job_title String Job title of the Contact.
personal_phone String Phone of the Contact.
mobile_phone String Mobile phone of the Contact.
city String City of the Contact.
state String State of the Contact.
country String Country of the Contact.
twitter String Twitter of the Contact.
facebook String Facebook of the Contact.
linkedin String Linkedin of the Contact.
tags ArrayStrings Tags of the Contact.
extra_emails ArrayStrings Extra emails of the Contact.
legal_bases ArrayObjects Legal Bases of the Contact.

Empty Fields

For empty value fields the following behavior will be adopted:

Type Description
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": "RD Station Developer",
  "email": "contact@example.com",
  "job_title": "Developer",
  "bio": "This documentation explains the RD Station API.",
  "website": "https://developers.rdstation.com/",
  "linkedin": "rd_station",
  "personal_phone": "+55 48 3037-3600",
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "tags": ["developer", "rdstation", "api"],
  "extra_emails": ["contact2@example.com"],
  "cf_custom_field_2": "custom field value2",
  "legal_bases": [
    {
      "category": "data_processing",
      "type": "pre_existent_contract"
    },
    {
      "category": "communications",
      "type": "consent",
      "status": "granted"
    }
  ]
}

Legal Bases
Field Type Valid params
category String data_processing or communications
type String pre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
status String granted or declined (only when category is communications)

Obs: When the category is data_processing the field status is not mandatory, but pay attention to the fact that if you include this field, the only accepted value for status is granted.

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 String The api_identifier of the Contact Field that uniquely identifies the Lead.
Currently only email or uuid are supported
value String The value for the given identifier
e.g. contact@example.org or 5408c5a3-4711-4f2e-8d0b-13407a3e30f3

Request Body Default Parameters
Field Type Description
email String Email of the Contact
name String Name of the Contact
bio String Notes about the Contact.
job_title String Job title of the Contact
linkedin String Linkedin profile of the Contact
facebook String Facebook profile of the Contact
city String City of the Contact.
state String State of the Contact.
country String Country of the Contact.
twitter String Twitter profile of the Contact
personal_phone String Personal phone of the Contact
mobile_phone String Mobile phone number of the Contact
website String Website of the Contact
tags ArrayStrings Tags of the Contact
legal_bases ArrayObjects Legal Bases 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.

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

Response Body Parameters
Field Type Description
uuid String The unique uuid associated to each RD Station Contact.
name String Name of the Contact.
email String Email of the Contact.
bio String Notes about the Contact.
website String Website of the Contact.
job_title String Job title of the Contact.
personal_phone String Phone of the Contact.
mobile_phone String Mobile phone of the Contact.
city String City of the Contact.
state String State of the Contact.
country String Country of the Contact.
twitter String Twitter of the Contact.
facebook String Facebook of the Contact.
linkedin String Linkedin of the Contact.
tags ArrayStrings Tags of the Contact.
extra_emails ArrayStrings Extra emails of the Contact.
legal_bases ArrayObjects Legal Bases of the Contact.

Empty Fields

For empty value fields the following behavior will be adopted:

Type Description
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": "RD Station Developer",
  "email": "contact@example.com",
  "job_title": "Developer",
  "bio": "This documentation explains the RD Station API.",
  "website": "https://developers.rdstation.com/",
  "linkedin": "rd_station",
  "personal_phone": "+55 48 3037-3600",
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "tags": ["developer", "rdstation", "api"],
  "extra_emails": ["contact2@example.com"],
  "cf_custom_field_2": "custom field value2",
  "legal_bases": [
    {
      "category": "data_processing",
      "type": "pre_existent_contract"
    },
    {
      "category": "communications",
      "type": "consent",
      "status": "granted"
    }
  ]
}

Legal Bases
Field Type Valid params
category String data_processing or communications
type String pre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
status String granted or declined (only when category is communications)

Obs: When the category is data_processing the field status is not mandatory, but pay attention to the fact that if you include this field, the only accepted value for status is granted.