Skip to content

contact.updated

Sent with the contact as it is after the change, and what changed. Use it to keep your own contact records current. A new WhatsApp profile name alone sends nothing.

Called Contact updated in the app. Part of the plan feature webhooks.contacts. To subscribe over the API, the key needs contacts:read.

What’s in data. Every event wraps it in the same envelope.

contact object

The contact as it is after the change.

Show 12 child attributesHide child attributes

contact.id string · uuid

contact.phone string · nullable

The number as + and its digits. null for a contact known only by a WhatsApp username.

contact.whatsapp_user_id string · nullable

The ID WhatsApp gives a contact who uses a WhatsApp username. null if WhatsApp hasn’t given Soosh one.

contact.name string · nullable

The name your business gave the contact, in the app or through the API. null if nobody has. A new WhatsApp profile name never replaces it.

contact.whatsapp_name string · nullable

The contact’s own WhatsApp profile name.

contact.attributes object

Your own fields on the contact. Names are 1 to 64 letters, digits or underscores.

A map; each value is a string or number or boolean.

contact.tags array of strings

contact.marketing_opt_out boolean

Whether the contact opted out of marketing messages.

contact.number_id string · uuid · nullable

The WhatsApp number the contact is usually messaged from.

contact.chat object

The contact’s chat. last_inbound_at covers any number. The 24-hour window is per number, so don’t work it out from this field.

Show 4 child attributesHide child attributes

contact.chat.status string

One of open closed.

contact.chat.assigned_agent_id string · uuid · nullable

contact.chat.last_message_at string · date-time · nullable

contact.chat.last_inbound_at string · date-time · nullable

contact.created_at string · date-time

contact.updated_at string · date-time

changed array of strings

The fields that changed. More values may be added.

Any of name attributes tags number_id marketing_opt_out. At least 1 item.

  • Answer with any 2xx within 10 seconds. Do the work after.
  • Check the signature first. Verify webhooks has the code.
  • Subscribe with POST /v1/webhooks, events: ["contact.updated"].