Create a contact

Authorization

Bearer

AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

account_id?string

Social account ID for initial channel

email?string

Email address

Lengthlength <= 320

identifier?string

Platform identifier for initial channel

Lengthlength <= 1024

metadata?

Freeform metadata

name?string

Contact name

Lengthlength <= 256

opted_in?boolean

Marketing preference. An explicit value is recorded for every known channel.

phone?string

Primary phone number

Length1 <= length <= 80

platform?string

Platform for initial channel

tags?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/v1/contacts" \  -H "Content-Type: application/json" \  -d '{}'

{  "channels": [    {      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "identifier": "string",      "platform": "string",      "social_account_id": "string"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "email": "string",  "id": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "opted_in": true,  "phone": "string",  "segment_ids": [    "string"  ],  "tags": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z",  "workspace_id": "string"}

Found something wrong? Help us improve this page.

Report an issue Edit this page on GitHub

Clear a custom field value for a contact DELETE

Delete a contact DELETE

Create a contact

Authorization

Request Body

Response Body

201application/json

400application/json

409application/json

`application/json`

`application/json`

`application/json`