Contacts

Update a contact

Updates the fields you name and keeps the rest. metadata merges into the stored metadata by key, and a null value deletes that key. profile replaces each field it names and null clears one; its customFields merge by key the same way. Identities and tags are not updated here: use POST /v1/contacts/{id}/identities, DELETE /v1/contacts/{id}/identities/{identityId}, POST /v1/contacts/{id}/tags, and DELETE /v1/contacts/{id}/tags.

patch/v1/contacts/{id}

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/contacts/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Request body

namestring nullable
displayNamestring nullable
avatarstring nullable
status'active' | 'paused' | 'blocked' | 'archived' nullable
statusReasonstring nullable
externalIdstring nullable
metadataJsonObject

Response

Contact

idstring required
namespaceIdstring required
namestring required
displayNamestring nullable required
avatarstring nullable required
status'active' | 'paused' | 'blocked' | 'archived' required
statusReasonstring nullable required
externalIdstring nullable required
tagsstring[] required
metadataJsonObject required
createdAtstring required
updatedAtstring required

Changes

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