Skip to content

Set a contact's name on a list

PUT
/v2/contact-lists/{id}/contacts/{contactId}/name
curl --request PUT \
--url https://api.connect.ms/v2/contact-lists/example/contacts/example/name \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "firstName": "example", "lastName": "example" }'

Gives a member of a static list its own name on that list, so one number can be “Tom” on one list and “Ellie” on another. Sends to the list use it for firstName and lastName. Blank fields clear it.

id
required
string

The id of the list.

contactId
required
string

The id of the contact, which must be a member of the list.

Connect-Version
string

The API version to use, for example 2026-10-01. Defaults to the version set on your API key.

The name the contact goes by on this list. Leave both blank to use the contact’s own name again.

Media typeapplication/json

The name the contact goes by on this list. Leave both blank to use the contact’s own name again.

object
firstName

The first name on this list. Null or blank falls back to the contact’s own.

string
nullable 0 <= 80 characters
lastName

The last name on this list. Null or blank falls back to the contact’s own.

string
nullable 0 <= 80 characters

Example generated

{
"firstName": "example",
"lastName": "example"
}

The contact, with its name on this list.

Media typeapplication/json

A contact in the workspace address book.

object
id
required

The unique id of the contact.

string
number
required

The contact’s phone number (E.164 format).

string
country

The ISO 3166-1 alpha-2 country of the number, or null when it cannot be determined.

string
nullable
firstName

The contact’s first name.

string
nullable
lastName

The contact’s last name.

string
nullable
company

The contact’s company.

string
nullable
email

The contact’s email address.

string
nullable
clientReference

Your own reference for the contact.

string
nullable
tags
required

The contact’s tags, sorted.

Array<string>
suppressed
required

True when the number is on the suppression list, so sends to it are refused.

boolean
createdAt
required

When (UTC) the contact was created.

string format: date-time
updatedAt
required

When (UTC) the contact last changed.

string format: date-time
nameOnList
One of:

The name a contact goes by on one list. A null field falls back to the contact’s own.

object
firstName

The first name on this list.

string
nullable
lastName

The last name on this list.

string
nullable

Example generated

{
"id": "example",
"number": "example",
"country": "example",
"firstName": "example",
"lastName": "example",
"company": "example",
"email": "example",
"clientReference": "example",
"tags": [
"example"
],
"suppressed": true,
"createdAt": "2026-04-15T12:00:00Z",
"updatedAt": "2026-04-15T12:00:00Z",
"nameOnList": {
"firstName": "example",
"lastName": "example"
}
}

The request is not valid. The detail field says why, and errors lists any problems by field name.

Media typeapplication/problem+json

Why a request failed, in the RFC 9457 problem details format.

object
type
required

A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.

string
title
required

A short, fixed summary of the kind of problem.

string
status
required

The HTTP status code of the response.

integer format: int32
detail

What went wrong with this particular request, when there is more to say than the title.

string
nullable
errors

For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).

object
key
additional properties
Array<string>
requestId
required

The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"requestId": "example"
}

The API key or bearer token is missing or not valid, or the request signature could not be verified.

Media typeapplication/problem+json

Why a request failed, in the RFC 9457 problem details format.

object
type
required

A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.

string
title
required

A short, fixed summary of the kind of problem.

string
status
required

The HTTP status code of the response.

integer format: int32
detail

What went wrong with this particular request, when there is more to say than the title.

string
nullable
errors

For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).

object
key
additional properties
Array<string>
requestId
required

The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"requestId": "example"
}

The caller is not allowed to do this.

Media typeapplication/problem+json

Why a request failed, in the RFC 9457 problem details format.

object
type
required

A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.

string
title
required

A short, fixed summary of the kind of problem.

string
status
required

The HTTP status code of the response.

integer format: int32
detail

What went wrong with this particular request, when there is more to say than the title.

string
nullable
errors

For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).

object
key
additional properties
Array<string>
requestId
required

The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"requestId": "example"
}

No contact list with that id, or the contact is not a member of it.

Media typeapplication/problem+json

Why a request failed, in the RFC 9457 problem details format.

object
type
required

A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.

string
title
required

A short, fixed summary of the kind of problem.

string
status
required

The HTTP status code of the response.

integer format: int32
detail

What went wrong with this particular request, when there is more to say than the title.

string
nullable
errors

For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).

object
key
additional properties
Array<string>
requestId
required

The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"requestId": "example"
}

The list is the built-in list or a dynamic list.

Media typeapplication/problem+json

Why a request failed, in the RFC 9457 problem details format.

object
type
required

A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.

string
title
required

A short, fixed summary of the kind of problem.

string
status
required

The HTTP status code of the response.

integer format: int32
detail

What went wrong with this particular request, when there is more to say than the title.

string
nullable
errors

For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).

object
key
additional properties
Array<string>
requestId
required

The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"requestId": "example"
}

The service is temporarily unavailable. Retry after the Retry-After header.

Media typeapplication/problem+json

Why a request failed, in the RFC 9457 problem details format.

object
type
required

A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.

string
title
required

A short, fixed summary of the kind of problem.

string
status
required

The HTTP status code of the response.

integer format: int32
detail

What went wrong with this particular request, when there is more to say than the title.

string
nullable
errors

For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).

object
key
additional properties
Array<string>
requestId
required

The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"requestId": "example"
}