Adicionar contacto

URL da API

URL utilizado para enviar pedidos HTTP:

https://portal.bulkgate.com/api/1.0/address-book/add

Nota

Se o pedido não chegar ao destino, repita-o no servidor de reserva backup1.bulkgate.com.

Métodos HTTP suportados

POST - application/json

POST /api/1.0/address-book/add HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Tabela de parâmetros

NOME DO PARÂMETRO	VALOR	OBRIGATÓRIO	VALOR PREDEFINIDO
application_id	ID da aplicação	Sim	-
application_token	Token da aplicação	Sim	-
groups	Array de ID dos grupos aos quais os contactos serão adicionados	Não	-
group_name	O contacto será adicionado a um novo grupo com o nome `group_name`	Não	-
data	Informações do contacto	Sim	Objeto data
category	A agenda de contactos com que se trabalha. Por predefinição, a agenda principal da conta.	Não	`main`
duplicity_action	O que fazer com um contacto que já existe — `restrict` (rejeitar), `skip` (ignorar), `update` (preencher os campos vazios), `rewrite` (substituir).	Não	`restrict`

Objeto data

NOME DO PARÂMETRO	VALOR	OBRIGATÓRIO	VALOR PREDEFINIDO
type	Tipo de contacto (pessoa/empresa)	Não	-
phone_mobile	Número de telefone principal	Não	-
title_before	Título antes do nome	Não	-
first_name	Nome próprio	Não	-
last_name	Apelido	Não	-
title_after	Título depois do nome	Não	-
gender	male / female / transgender / agender / non_binary / unknown	Não	unknown
company_name	Nome da sua empresa	Não	-
email	E-mail	Não	-
url	URL do seu website	Não	-
street1	Morada, linha 1	Não	-
street2	Morada, linha 2	Não	-
city	Cidade	Não	-
zip	Código postal	Não	-
state	Estado	Não	-
country	Código do país no formato ISO 3166-1 alpha-2	Não	`null`
company_number	Número da empresa	Não	-
company_vat	NIF da empresa	Não	-
note	Nota	Não	-
custom_field_0	Campo personalizado	Não	-
custom_field_1	Campo personalizado	Não	-
custom_field_2	Campo personalizado	Não	-
custom_field_3	Campo personalizado	Não	-
custom_field_4	Campo personalizado	Não	-
custom_field_5	Campo personalizado	Não	-
custom_field_6	Campo personalizado	Não	-
custom_field_7	Campo personalizado	Não	-
custom_field_8	Campo personalizado	Não	-
custom_field_9	Campo personalizado	Não	-

Exemplo de pedido

POST /api/1.0/address-book/add HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "groups": [1, 2], "group_name": "Talos 1", "data": { "first_name": "Morgan", "last_name": "Yu", "phone_mobile": "123456789", "street1": "Crew's quarters", "street2": "Executive suite", "country": "Talos 1", "email": "morganyu@talos.com" } }

Resposta

Em caso de sucesso:

{ "data": { "message": "contact_has_been_added", "groups": [1,2,3] } }

Em caso de erro:

{ "type": "contact_with_this_phone_number_already_exists", "code": 400, "error": "Contact with this phone number already exists", "detail": null }

{ "type": "invalid_phone_mobile", "code": 400, "error": "Invalid phone mobile", "detail": null }

{ "type": "group_not_found", "code": 400, "error": "Group not found", "detail": null }

Em que:

type e error (descrição do erro) encontram-se na tabela de tipos de erros
code representa o código de erro HTTP
detail contém informações adicionais sobre o erro

Esta página foi útil?

Perguntar à IA Copiado