People

Update a contact

Updates the given fields; changes of name, email, phone and company are written to the timeline. Role permission: data.write.

patch/people/{id}

Request

  • Base URL: https://joinways.app/api/v1
  • URL: https://joinways.app/api/v1/people/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://joinways.app/oauth/authorize, token URL https://joinways.app/api/oauth/token, scopes: mcp.write)

Headers

Idempotency-Keystring

Optional client-generated key (1 to 255 characters, e.g. a UUID v4) that makes the request idempotent for 24 hours: a retry with the same key replays the recorded response (marked Idempotency-Replayed: true) instead of executing the operation again. Same key with another body: 422 idempotency_key_reuse; while the first request runs: 409 idempotency_conflict. See the Idempotency section.

Request body

first_namestring
last_namestring
emailstring email
phonestring
company_idstring uuid
notesstring
job_titlestring
rolestring

Same as job_title.

Response

The updated contact.

idstring uuid
first_namestring nullable
last_namestring nullable
emailstring nullable
phonestring nullable
rolestring nullable

Job title (stored name).

job_titlestring nullable

Job title, same value as role.

company_idstring uuid nullable
notesstring nullable
enrichment_statusstring nullable
enrichment_completed_atstring date-time nullable
created_atstring date-time nullable
updated_atstring date-time nullable
account_idstring uuid
email_sharedboolean
sourcestring nullable
source_metadataobject nullable
external_idstring nullable
enrichment_dataobject nullable

Example response

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@acme.com",
  "role": "Head of Events",
  "job_title": "Head of Events"
}

Changes

No recorded changes to this operation across all 1 revision of this API.