Update a contact by phone number

patch

https://platform.textingline.com/api/v1/contacts/by-phone/{phoneNumber}

Updates profile fields on the contact identified by phoneNumber. Uses JSON Merge Patch semantics: any field absent from the body is left unchanged; sending a field with a value sets it; sending null (or an empty string, for nullable string fields) clears it.

The phone number itself cannot be changed — the URL path is the canonical identifier. Any unknown property in the body is rejected with a 400.

customFields are validated against the user's current schema. Unknown indexes, type mismatches, invalid dates, and unknown select options are rejected with error code 33033 and a machine-readable details.reason.

Group memberships and pending memberships cannot be modified through this endpoint — use the dedicated membership endpoints.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

phoneNumber

string

required

Contact phone number in E.164 format (+ then country code and subscriber number).

Body Params

firstName

object | null

Contact's first name.

lastName

object | null

Contact's last name.

object | null

Contact's email address.

birthDate

object | null

Date of birth, strict YYYY-MM-DD format. Full ISO datetimes are rejected.

gender

string | null

enum

Contact's gender.

Allowed:

address

object | null

Contact's mailing address. Per-sub-field merge: only sub-fields present in the payload are touched. Send address: null to clear the entire embed; send a sub-field with null to clear that sub-field only.

isFavorite

boolean

Whether the contact is flagged as favorite by the operator.

customFields

object | null

Custom-field values keyed by label (the human-readable name you gave the field). Labels are matched case-insensitively after trimming whitespace. Per-label merge: only labels present in the payload are touched. Send customFields: null to clear all values; send an individual label with null to clear that value; send "" to clear TEXT values; send [] to clear MULTI_SELECT values. Discover labels, types, and select options via GET /v1/contacts/custom-fields/schema. Value shape per schema field type: TEXT → string, NUMBER → number, BOOLEAN → boolean, DATE → YYYY-MM-DD string, SINGLE_SELECT → string matching one of options, MULTI_SELECT → array of strings each matching one of options. Unknown labels are rejected with 33033 InvalidCustomField and details.reason: "unknown_label".

Responses

200Contact updated.

404Contact not found.