contacts

Update a contact

Changed on

Update notes, outreach status, tags or profile data for a person, or remove them from a list and bring them back. lifecycleStage is per-list: pass campaignId to scope the write to one list, or the request is rejected.

patch/contacts/{id}

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/contacts/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Contact ID

Query parameters

campaignIdstring

Scopes the write to one list. Required with lifecycleStage: take it from the person's campaigns in a contacts result.

Request body

lifecycleStage'contact' | 'lead' | 'rejected'

rejected removes the person from the list, contact brings them back.

notesstring
namestring

Update contact name

profileDataunknown
profileUpdatedAtstring

When profileData was last refreshed

conversationDataunknown
conversationUpdatedAtstring

When conversationData was last synced

outreachStatus'none' | 'connection_sent' | 'connected' | 'dm_sent' | 'followed_up' | 'replied' | 'in_conversation' | 'meeting_booked' | 'not_interested'

Manual outreach status override

doNotContactboolean

Flag contact as do-not-contact

Response

Updated contact

successtrue required
creditsUsedinteger required

Credits this call spent, net of anything given back. 0 when nothing was charged: a free read, a cached answer, nothing delivered.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.

Changes

  • 549f4adbbfcfRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • bdaed6984b20Revision changes
    • warning

      removed the optional property from the response with the status