Targets

Update target alias

Set or clear a custom display name (alias) for a target. Alias takes priority over the WhatsApp contact name in all views. Pass null to remove the alias.

patch/api/v1/targets/{id}/alias

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/targets/{id}/alias
  • Auth: bearerAuth (a scheme the document does not define)

Path parameters

idstring uuid required

Resource UUID

Request body

aliasstring nullable required

Response

Updated

successtrue required
messagestring

Example response

{
  "data": {
    "name": "John Doe",
    "phone": "+525512345678"
  }
}

Changes

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