Create contact

Creates a contact, or returns the existing one when the address is already in the workspace. 201 when created, 200 when it already existed, so posting the same person twice is safe.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Request Body

application/jsonRequired

firstNameRequiredstring

lastNameRequiredstring

emailRequiredstring

Format: "email"

phonestring

companystring

jobTitlestring

accountIdstring

Format: "uuid"

sourcestring

tagsarray<string>

notesstring

curl -X POST "https://clientsphere.io/api/v1/contacts" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane@acme.com",
    "phone": "string",
    "company": "string",
    "jobTitle": "string",
    "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
    "source": "website",
    "tags": [
      "string"
    ],
    "notes": "string"
  }'

The contact already existed and was returned unchanged. Any accountId in the body is still linked.

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
    "firstName": "string",
    "lastName": "string",
    "email": "user@example.com",
    "phone": "string",
    "company": "string",
    "jobTitle": "string",
    "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
    "source": "string",
    "tags": [
      "string"
    ],
    "notes": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Create contact

Authorization

Request Body

Response

TypeScript