Create person

Authorization

bearerAuth

AuthorizationBearer <token>

Paste the full personal access token or organization API key value. Examples: acq_live_..., acq_org_.... Tokens can be limited to resource/action scopes such as workspaces:read, people:write, and deals:write. Some integration endpoints require an organization key even when a personal token has the named resource scope.

In: header

Path Parameters

workspaceId*string

Workspace id.

Formatuuid

Header Parameters

idempotency-key?string

Optional for organization API keys on endpoints that explicitly support synchronous idempotency. Reuse the same key only with the same workspace, action, target, and request body. A successful replay returns the original HTTP status, response body, and Location header. Personal access tokens cannot use this header.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Person display name.

Length1 <= length <= 160

firstName?|

Structured first name. When supplied, structured name parts take precedence over name.

Lengthlength <= 500

lastName?|

Structured last name. When supplied, structured name parts take precedence over name.

Lengthlength <= 500

title?|

Person job title.

Lengthlength <= 500

image?|

Person image URL.

Lengthlength <= 2048

facebook?|

Lengthlength <= 500

instagram?|

Lengthlength <= 500

linkedin?|

Lengthlength <= 500

twitter?|

Lengthlength <= 500

tags?array<>|

Person tags. Null means no tags are set.

Itemsitems <= 50

emails?array<>

Email addresses ordered by priority. When present, replaces all existing emails. Use an empty array to clear emails.

Itemsitems <= 50

phones?array<>

Phone numbers ordered by priority. When present, replaces all existing phone numbers. Use an empty array to clear phone numbers.

Itemsitems <= 50

addresses?array<>

Addresses. When present, replaces all existing addresses. Use an empty array to clear addresses.

Itemsitems <= 50

customFields?array<>

Custom field values to set atomically with the person. Use null to clear a value.

Itemsitems <= 100

ownerId?|

Workspace member user id that should own this person. Defaults to the personal access-token owner and defaults to null for organization API keys.

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/people" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",    "name": "string",    "firstName": "string",    "lastName": "string",    "title": "string",    "description": "string",    "website": "string",    "image": "string",    "facebook": "string",    "instagram": "string",    "linkedin": "string",    "twitter": "string",    "tags": [      "string"    ],    "emails": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "email": "user@example.com",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "phones": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "number": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "addresses": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "street": "string",        "city": "string",        "state": "string",        "postalCode": "string",        "country": "string",        "type": "billing",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "customFields": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "label": "string",        "type": "text",        "value": "string"      }    ],    "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "links": {      "self": "http://example.com"    }  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

{  "error": {    "code": "string",    "message": "string",    "requestId": "string",    "details": null  }}

Create person

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

408application/json

409application/json

413application/json

415application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`