TagMangoTagMango Docs
Account

Update Customer Contact Details

PATCH
/api/v1/external/users/{userId}

Updates a customer's name, email, phone, or country.

Usage

  • Send at least one non-null field; omitted fields stay unchanged.
  • Phone validation uses the country after this update.
  • Repeating the stored values is accepted and leaves the user unchanged.

External access policy

An API key and an authorized white-label host are required. Both tier and plan requirements are enforced.

These requirements apply to the white-label creator for backend-to-backend access. TagMango platform access is not supported.

  • Plans: Unrestricted.

  • Tiers: Unrestricted.

AuthorizationBearer <token>

In: header

Path Parameters

userId*string

The 24-character customer ID returned by Get User By Email or Phone.

Header Parameters

x-whitelabel-host*string

Host name of the dashboard, ex: mydomain.tagmango.com

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api-prod-new.tagmango.com/api/v1/external/users/62ea773dfc87495de3894e73" \  -H "x-whitelabel-host: string" \  -H "Content-Type: application/json" \  -d '{    "name": "Priya Sharma"  }'
{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": 1234567890,
  "dialCode": "+91",
  "_id": "6659ca9e5f2acb7abfdcd8fd",
  "country": "IN"
}
{
  "code": 400,
  "type": "Bad Request",
  "statusMessage": "BAD_REQUEST",
  "errorCode": "USER_CONTACT_INVALID",
  "message": "Send at least one valid name, email, phone, or country value.",
  "result": "Send at least one valid name, email, phone, or country value.",
  "success": false
}
{
  "code": 401,
  "type": "Unauthorized",
  "statusMessage": "UNAUTHORIZED",
  "message": "Invalid token",
  "result": "Invalid token",
  "success": false
}
{
  "code": 403,
  "type": "Forbidden",
  "statusMessage": "FORBIDDEN",
  "errorCode": "WORKSHOP_MANGO_FORBIDDEN",
  "message": "You can not access this api with a TagMango account, only available for whitelabel hosts",
  "result": "You can not access this api with a TagMango account, only available for whitelabel hosts",
  "success": false
}
{
  "code": 404,
  "type": "Not Found",
  "statusMessage": "NOT_FOUND",
  "errorCode": "USER_NOT_FOUND",
  "message": "The specified user does not exist or is not registered on this platform.",
  "result": "The specified user does not exist or is not registered on this platform.",
  "success": false
}
{
  "code": 409,
  "type": "Conflict",
  "statusMessage": "CONFLICT",
  "errorCode": "USER_CONTACT_CONFLICT",
  "message": "Another user on this host already uses the requested email or phone.",
  "result": "Another user on this host already uses the requested email or phone.",
  "success": false
}
{
  "code": 429,
  "type": "Too Many Requests",
  "statusMessage": "TOO_MANY_REQUESTS",
  "message": "Request limit exceeded. try after 10 seconds",
  "result": "Request limit exceeded. try after 10 seconds",
  "success": false
}
{
  "code": 500,
  "type": "UnknownError",
  "statusMessage": "INTERNAL_SERVER_ERROR",
  "errorCode": "USER_UPDATE_FAILED",
  "message": "The update could not be completed. Retrieve the user before retrying because the change may already be stored.",
  "result": "The update could not be completed. Retrieve the user before retrying because the change may already be stored.",
  "success": false
}