Saltar al contenido principal
POST
Crear o actualizar contacto

Autorizaciones

x-api-key
string
header
requerido

Copy the API key as provided by the Bridge Console.

Parámetros de ruta

workspaceId
string<uuid>
requerido

Identificador único del workspace (UUID v4).

Ejemplo:

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

Cuerpo

application/json

Cuerpo de la solicitud para crear un contacto parcial. Solo cellphone es obligatorio.

cellphone
string
requerido

Número de celular del contacto. Si no incluye código de país, se interpreta según el país del workspace. Se utiliza para identificar al contacto durante el upsert.

Ejemplo:

"+14084029292"

firstName
string | null

Nombre del contacto. Obligatorio para la clasificación NORMAL.

Ejemplo:

"Maria"

lastName
string | null

Apellido del contacto. Obligatorio para la clasificación NORMAL.

Ejemplo:

"Lopez"

email
string<email> | null

Correo electrónico del contacto.

Ejemplo:

"maria@acme.com"

languageCode
enum<string> | null

Código de idioma del contacto. Obligatorio para la clasificación NORMAL.

Opciones disponibles:
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
Ejemplo:

"EN"

ownerIdentifier
InternalUserIdentifierRequest · object | null

Cuerpo para identificar a un usuario interno en Bridge.

Ejemplo:
customAttributes
Custom Attributes · object

Objeto con atributos personalizados abiertos y cerrados.

Ejemplo:

Respuesta

Respuesta satisfactoria

Cuerpo de respuesta para operaciones con contactos.

id
string
requerido

Identificador único del contacto (UUID v4).

Ejemplo:

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

workspaceId
string
requerido

Identificador único del workspace al que pertenece este contacto

Ejemplo:

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

type
enum<string>
requerido

NORMAL cuando están presentes todos los campos obligatorios de identidad y atributos personalizados; PARTIAL en caso contrario.

Opciones disponibles:
PARTIAL,
NORMAL
Ejemplos:

"NORMAL"

"PARTIAL"

createdAt
string
requerido

Fecha y hora de creación del contacto.

Ejemplo:

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

updatedAt
string
requerido

Fecha y hora de la última actualización del contacto.

Ejemplo:

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

firstName
string | null

Nombre del contacto.

Ejemplo:

"John"

lastName
string | null

Apellido del contacto.

Ejemplo:

"Doe"

email
string<email> | null

Correo electrónico del contacto.

Ejemplo:

"john.doe@example.com"

cellphone
string<phone> | null

Número de celular del contacto.

Ejemplo:

"+14084029292"

customAttributes
CustomAttributeResponse · object[]

Lista de atributos personalizados de clave y valor.

languageCode
enum<string> | null

Código de idioma del usuario externo.

Opciones disponibles:
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
Ejemplo:

"EN"

ownerId
string | null

ID del Bridge User propietario del contacto. Resuélvelo con GET /users/{userId}.

Ejemplo:

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