Add Notification Contact

Registers an email or phone contact for the authenticated login. Up to 3 per type.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Registers an email or phone contact for the authenticated login. Up to 3 per type (3 emails + 3 phones).

Request body

FieldTypeRequiredDescription
typestringyesemail or phone (lowercase).
valuestringyesEmail address, or phone in international format with country code: +5511999990000.
{ "type": "phone", "value": "+5511999990000" }
⚠️

Phone numbers must use international format with + and country code. (11) 99999-0000 returns 400. This is different from the user's phone field, which accepts free text.

Example response

{ "id": "{contact_id}", "type": "phone", "value": "+5511999990000" }

Errors

Error codeCause
CONTACT_ALREADY_EXISTSThis address is already registered for the login.
CONTACT_LIMIT_REACHEDThe login already has 3 contacts of this type.
BadRequestInvalid type, email or phone format.
Body Params
string
enum
required

Contact type. Lowercase.

Allowed:
string
required

Email address or phone in international format with country code: +5511999990000.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json