contacts
contacts

Update Person

Update person details (birthday, preferred channel).

Birthday fields:

  • birthday_month: 1-12 (required if birthday_day is set)
  • birthday_day: 1-31 (required if birthday_month is set)
  • birthday_year: optional, 1900-2100

To clear birthday, set both birthday_month and birthday_day to None.

patch/api/contacts/{person_id}

Request

  • Base URL: https://api.dialogbrain.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dialogbrain.com/api/contacts/{person_id}
  • Auth: none declared

Path parameters

person_idinteger required

Request body

display_namestring nullable
birthday_monthinteger nullable
birthday_dayinteger nullable
birthday_yearinteger nullable
preferred_channelstring nullable
staff_rolestring nullable
capabilitiesstring[] nullable
notesstring nullable
preferred_channel_account_idinteger nullable

Response

Successful Response

idinteger required
display_namestring required
birthday_monthinteger nullable
birthday_dayinteger nullable
birthday_yearinteger nullable
preferred_channelstring nullable
staff_rolestring nullable
capabilitiesstring[]
notesstring nullable
preferred_channel_account_idinteger nullable

Changes

No recorded changes to this operation across all 5 revisions of this API.