v1

latestOpenAPI 3.0.02026-07-26626596.3 KB

Leads

Atualizar lead

patch/api/v1/leads/{id}

Path parameters

idstring required

Request body

namestring

Array de ID de tags

imagestring

Url da Imagem do lead

phonestring

Telefone do lead

emailstring

Email do lead

sourcestring

Origem do lead

companystring

Empresa do lead

taxIdstring

Documento de identificação

sitestring

Site do lead

instagramstring

Instagram do lead

Example request

{
  "name": "Guilherme Gavazzoni",
  "image": "https://dc-qqqq2222pb.s3.amazonaws.com/0a7ac87c-2f50-46b5-9c39-80ffec53e633/1163f5c2-62f4-443f-a84f-9c223b05ae3b",
  "phone": "+55 (47) 991331190",
  "email": "guilherme@datacrazy.com.br",
  "source": "Google ads",
  "company": "Apple",
  "taxId": "108.154.702-92",
  "site": "www.meulead.com.br",
  "instagram": "@guilhermegavazzoni",
  "sourceReferral": {
    "sourceId": "2bc3d979-93a4-4e64-8903-5d9379d3de91",
    "sourceUrl": "https://example.com/artigo-de-origem",
    "ctwaId": "849fefab-e697-4720-9303-e788c23790cc"
  }
}

Response

idstring

Id do lead

createdAtstring date-time

Data de criação do lead

namestring

Nome do lead

imagestring

Url da Imagem do lead

phonestring

Telefone do lead

rawPhonestring

Telefone do lead (apenas números)

emailstring

Email do lead

sourcestring

Origem do lead

companystring

Empresa do lead

taxIdstring

Documento de identificação

sitestring

Site do lead

instagramstring

Instagram do lead

listsstring[]

Array de listas atreladas ao lead

contactsLeadContactDto

Example response

{
  "id": "15b41959-b04d-4a99-b878-6e45fffa7633",
  "createdAt": "2025-06-11T18:31:25.203Z",
  "name": "Guilherme Gavazzoni",
  "image": "https://dc-qqqq2222pb.s3.amazonaws.com/0a7ac87c-2f50-46b5-9c39-80ffec53e633/1163f5c2-62f4-443f-a84f-9c223b05ae3b",
  "phone": "+55 (47) 991331190",
  "rawPhone": "5547991331190",
  "email": "guilherme@datacrazy.com.br",
  "source": "Google ads",
  "company": "Apple",
  "taxId": "108.154.702-92",
  "site": "www.meulead.com.br",
  "instagram": "@guilhermegavazzoni",
  "tags": {
    "id": "cb3e8d24-ccad-43d1-acd5-08580d9bc674",
    "name": "marketing orgânico",
    "color": "#A78BFA",
    "description": "Leads que vieram de campanhas internas",
    "createdAt": "2025-03-25T14:12:47.738Z"
  },
  "lists": [
    {
      "id": "5343afav-e697-4720-9303-e788c23711dd",
      "name": "ativos",
      "color": "#EB2626",
      "description": "lista de compradores recorrentes",
      "createdAt": "2025-06-12T17:37:17.861Z"
    },
    {
      "id": "f2b3c92d-3843-406f-a3e3-672d2d7d2a27",
      "name": "inativos",
      "color": "#EB2626",
      "description": "lista de compradores de baixa frequência",
      "createdAt": "2025-12-03T17:28:09:5361Z"
    }
  ],
  "attendant": {
    "userId": "t9kn9mqPakdGG535GQK3hod8wzM2",
    "id": "6807e48c25ece34f9f1ba7dd",
    "name": "Joao Silva",
    "email": "joaosilva@gmail.com",
    "phone": "5547991331190",
    "imageURL": "https://dc-qqqq1111pb.s3.amazonaws.com/profiles/koQGLa8p68fNZiiSmE1tec2LHtc2_2025-05-24T00%3A27%3A23.486Z"
  },
  "sourceReferral": {
    "sourceId": "2bc3d979-93a4-4e64-8903-5d9379d3de91",
    "sourceUrl": "https://example.com/artigo-de-origem",
    "ctwaId": "849fefab-e697-4720-9303-e788c23790cc"
  }
}