Upsert contact

POST/v1/contacts/upsert

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings -> API Tokens). Sent as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

matchOn*string

Value in"email" | "phone" | "externalId"

email?string

Formatemail

phone?string

externalId?string

firstName?string

lastName?string

tags?array<string>

Response Body

`application/json`

cURL

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

{
  "contact": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "externalId": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "user@example.com",
    "phone": "+15558675309",
    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
    "tags": [
      "string"
    ],
    "source": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "action": "created"
}

Authorization

Request Body

Response Body

200application/json

`application/json`