Pular para o conteúdo principal
PATCH
Atualizar contato

Autorizações

x-api-key
string
header
obrigatório

Copy the API key as provided by the Bridge Console.

Parâmetros de caminho

workspaceId
string<uuid>
obrigatório

Identificador único do workspace (UUID v4).

Exemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

contactId
string<uuid>
obrigatório

Identificador único do contato (UUID v4).

Exemplo:

"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8"

Corpo

application/json

Corpo da solicitação para atualizar um contato existente.

firstName
string | null

Nome do contato.

Exemplo:

"John"

lastName
string | null

Sobrenome do contato.

Exemplo:

"Doe"

email
string<email> | null

E-mail do contato.

Exemplo:

"john.doe@example.com"

languageCode
enum<string> | null

Código de idioma do contato.

Opções disponíveis:
ES,
EN,
AF,
SQ,
AR,
AZ,
BN,
BG,
CA,
ZH_CN,
HR,
CS,
DA,
NL,
ET,
FIL,
FI,
FR,
KA,
DE,
EL,
GU,
HA,
HE,
HI,
HU,
ID,
GA,
IT,
JA,
KN,
KK,
RW_RW,
KO,
KY_KG,
LO,
LV,
LT,
MK,
MS,
ML,
MR,
NB,
FA,
PL,
PT_BR,
PA,
RO,
RU,
SR,
SK,
SL,
SW,
SV,
TA,
TE,
TH,
TR,
UK,
UR,
UZ,
VI,
ZU
Exemplo:

"EN"

cellphone
string | null

Número de celular do contato. Sem código de país, é interpretado conforme o país do workspace.

Exemplo:

"+14084029292"

ownerIdentifier
InternalUserIdentifierRequest · object | null

Corpo para identificar um usuário interno no Bridge.

customAttributes
Custom Attributes · object

Objeto com as listas openAttributes e closedAttributes.

Resposta

Resposta bem-sucedida

Corpo da resposta para operações com contatos.

id
string
obrigatório

Identificador único do contato (UUID v4).

Exemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

workspaceId
string
obrigatório

Identificador único do workspace ao qual este contato pertence

Exemplo:

"92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5"

type
enum<string>
obrigatório

NORMAL quando todos os campos obrigatórios de identidade e atributos personalizados estão presentes; PARTIAL caso contrário.

Opções disponíveis:
PARTIAL,
NORMAL
Exemplos:

"NORMAL"

"PARTIAL"

createdAt
string
obrigatório

Data e hora de criação do contato.

Exemplo:

"2003-04-10T08:00:00.000Z"

updatedAt
string
obrigatório

Data e hora da última atualização do contato.

Exemplo:

"2003-04-10T08:00:00.000Z"

firstName
string | null

Nome do contato.

Exemplo:

"John"

lastName
string | null

Sobrenome do contato.

Exemplo:

"Doe"

email
string<email> | null

E-mail do contato.

Exemplo:

"john.doe@example.com"

cellphone
string<phone> | null

Número de celular do contato.

Exemplo:

"+14084029292"

customAttributes
CustomAttributeResponse · object[]

Lista de atributos personalizados de chave e valor.

languageCode
enum<string> | null

Código de idioma do usuário externo.

Opções disponíveis:
ES,
EN,
AF,
SQ,
AR,
AZ,
BN,
BG,
CA,
ZH_CN,
HR,
CS,
DA,
NL,
ET,
FIL,
FI,
FR,
KA,
DE,
EL,
GU,
HA,
HE,
HI,
HU,
ID,
GA,
IT,
JA,
KN,
KK,
RW_RW,
KO,
KY_KG,
LO,
LV,
LT,
MK,
MS,
ML,
MR,
NB,
FA,
PL,
PT_BR,
PA,
RO,
RU,
SR,
SK,
SL,
SW,
SV,
TA,
TE,
TH,
TR,
UK,
UR,
UZ,
VI,
ZU
Exemplo:

"EN"

ownerId
string | null

ID do Bridge User proprietário do contato. Resolva-o com GET /users/{userId}.

Exemplo:

"37673840-6259-40f9-bbe5-a7db40f8e3cf"