v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB

Contatos

Atualizar contato pelo uuid/email/phone

Cria ou atualiza um contato existente na Base de Leads. <br>Não há o registro de Evento de Conversão no histórico do contato. <br>Caso o contato já exista, as Tags inseridas no contato são substituídas pelas novas tags enviadas na requisição. <br><br>Atenção: Ao atualizar o contato pelo email, o parâmetro "email" não deve ser enviado no Body.

patch/platform/contacts/{identifier}:{value}

Path parameters

identifier'uuid' | 'email' | 'phone' required

Identificador (uuid/email/phone) associado a cada contato do RD Station.

valuestring required

Valor do identificador.

Request body

namestring

Nome do contato

emailstring

Email do contato

phonestring

Telefone do contato

job_titlestring

Cargo do contato

birthdatestring

Data de Aniversário

biostring

Anotações sobre contato

websitestring

Site do contato

personal_phonestring

Telefone do contato

mobile_phonestring

Telefone do contato

citystring

Cidade do contato

statestring

Estado do contato

countrystring

País do contato

twitterstring

Twitter do contato

facebookstring

Facebook do contato

linkedinstring

LinkedIn do contato

tagsstring[]

Tags do contato

Example request

{
  "name": "RD Station Developer",
  "email": "contato@exemplo.com",
  "phone": "+5511999999999",
  "job_title": "Desenvolvedor",
  "birthdate": "1990-11-23",
  "bio": "Muito engajado",
  "website": "https://site-contato.rdstation.com/",
  "personal_phone": "+55 48 3037-3600",
  "mobile_phone": "+55 48 3037-3600",
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "twitter": "https://twitter.com/contato",
  "facebook": "https://www.facebook.com/contato/",
  "linkedin": "https://www.linkedin.com/in/contato/",
  "tags": [
    "developer",
    "rdstation",
    "api"
  ],
  "legal_bases": [
    {
      "category": "communications",
      "type": "consent",
      "status": "granted"
    }
  ]
}

Response

Success

uuidstring

UUID único do contato gerado no RD Station para controle e gerenciamento

namestring

Nome do contato

emailstring

Email do contato

phonestring

Telefone do contato

job_titlestring

Cargo do contato

birthdatestring

Data de Aniversário

biostring

Anotações sobre o contato

websitestring

Site do contato

personal_phonestring

Telefone do contato

mobile_phonestring

Telefone do contato

citystring

Cidade do contato

statestring

Estado do contato

countrystring

País do contato

twitterstring

Twitter do contato

facebookstring

Facebook do contato

linkedinstring

LinkedIn do contato

tagsstring[]

Tags do contato

extra_emailsstring[]

E-mails extras do contato

Example response

{
  "uuid": "cdbba2a8-8ccd-4228-9617-6b0257b32077",
  "name": "RD Station Developer",
  "email": "contato@exemplo.com",
  "phone": "+5511999999999",
  "job_title": "Desenvolvedor",
  "birthdate": "1990-11-23",
  "bio": "Muito engajado",
  "website": "https://site-contato.rdstation.com/",
  "personal_phone": "+55 48 3037-3600",
  "mobile_phone": "+55 48 3037-3600",
  "city": "Florianópolis",
  "state": "SC",
  "country": "Brasil",
  "twitter": "https://twitter.com/contato",
  "facebook": "https://www.facebook.com/contato/",
  "linkedin": "https://www.linkedin.com/in/contato/",
  "tags": [
    "developer",
    "rdstation",
    "api"
  ],
  "extra_emails": [
    "contact2@example.com"
  ],
  "legal_bases": [
    {
      "category": "communications",
      "type": "consent",
      "status": "granted"
    }
  ],
  "links": [
    {
      "rel": "SELF",
      "href": "https://api.rd.services/platform/contacts/uuid:cdbba2a8-8ccd-4228-9617-6b0257b32077",
      "media": "application/json",
      "type": "GET"
    },
    {
      "rel": "SELF",
      "href": "https://api.rd.services/platform/contacts/email:contato@exemplo.com",
      "media": "application/json",
      "type": "GET"
    },
    {
      "rel": "SELF",
      "href": "https://api.rd.services/platform/contacts/phone:+5511999999999",
      "media": "application/json",
      "type": "GET"
    },
    {
      "rel": "CONTACT.DELETE",
      "href": "https://api.rd.services/platform/contacts/uuid:cdbba2a8-8ccd-4228-9617-6b0257b32077",
      "media": "application/json",
      "type": "DELETE"
    },
    {
      "rel": "CONTACT.FUNNEL",
      "href": "https://api.rd.services/platform/contacts/cdbba2a8-8ccd-4228-9617-6b0257b32077/funnels/{funnel_name}",
      "media": "application/json",
      "type": "GET"
    },
    {
      "rel": "CONTACT.EVENTS",
      "href": "https://api.rd.services/platform/contacts/cdbba2a8-8ccd-4228-9617-6b0257b32077/events?event_type={event_type}",
      "media": "application/json",
      "type": "GET"
    }
  ]
}