Saltar para a documentação
API

Criar um contacto

Guarda um endereço no livro de endereços do workspace. O endereço é a identidade, pelo que não há id a escolher nem id na resposta. É aparado e passado a minúsculas antes de ser guardado, e o contacto fica gravado com `source` a `manual`. O novo contacto entra na audiência predefinida integrada no momento em que é escrito, além de tudo o que estiver indicado em `audienceIds`.

POSTapi.openemail.uk/contacts

Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.

POST /contacts

Guarda um endereço no livro de endereços do workspace. O endereço é a identidade, pelo que não há id a escolher nem id na resposta. É aparado e passado a minúsculas antes de ser guardado, e o contacto fica gravado com source a manual. O novo contacto entra na audiência predefinida integrada no momento em que é escrito, além de tudo o que estiver indicado em audienceIds.

Exemplo

Requer contacts:write. Enviar audienceIds requer também audiences:write.

curl
curl -X POST "$OE/contacts" -H "$AUTH" -H 'content-type: application/json' -d '{  "email": "[email protected]",  "name": "Grace Hopper",  "notes": "Met at the compiler workshop"}'
Resposta
{  "object": "contact",  "email": "[email protected]",  "name": "Grace Hopper",  "source": "manual",  "notes": "Met at the compiler workshop",  "lastSeenAt": null,  "createdAt": "2026-09-18T09:00:00.000Z",  "updatedAt": "2026-09-18T09:00:00.000Z",  "audiences": [    { "id": "aud_9f2c4b7e1a0d63d84c5f2e7b", "name": "All contacts", "builtin": "default" }  ]}

Um endereço que já conste do livro dá um 409 contact_exists em vez de uma fusão, para que uma repetição não possa sobrescrever em silêncio um nome que alguém editou na aplicação. Leia a linha e faça-lhe PATCH.

lastSeenAt fica a null até sair correio para o endereço a partir do compositor da aplicação. source e lastSeenAt pertencem ao servidor e não são aceites no corpo.

Um id de audiência em audienceIds que não exista neste workspace dá um 404 e nada é escrito.