Skip to navigation
Modular DS Public APIContactsContact methods

Set a contact's contact method

View as MarkdownOpen in Claude

Sets an email or a WhatsApp number on a contact. It replaces whichever method the contact already has, whatever its channel, because a contact keeps at most one.

Body

  • channel (email or whatsapp, required): a contact never holds a conventional phone.
  • value (string, required): at most 255 characters, a valid email address for email and a valid phone number for whatsapp.

Errors

  • 422: channel is not email or whatsapp, or value is not valid for the channel.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

contact_idstringRequired

Request

This endpoint expects an object.
channelstringOptional
valuestringOptional

Response

201 - Method stored

dataobjectOptional
jsonapiobjectOptional

Errors

422
Unprocessable Entity Error