customer-engagement

people

person-profile

Partial person update

Use this method to update a person profile with the data passed in the request body as follows:<br>1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute keeps its value.<br>2. Tags in the request are appended to the profile tag list.<br>3. New contact information (email addresses and phone numbers) in the request is appended to the contact list of the profile.

patch/people/2/persons

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- HTTP basic
- or API key in header Authorization
- or API key in header Authorization
- or OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token

Query parameters

identifierstring

Person ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request

senderstring

Sender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL

Type of the person ID

Request body

addressstring

Person's address, 256 characters max.

birthDatestring

Person's date of birth, format YYYY-MM-DD.

citystring

Person's city, 50 characters max.

computedAttributesobject

Person's computed attributes grouped by type.

countrystring

Person's country, 50 characters max.

createdAtstring

Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.

customAttributesobject

List of custom attributes for the person, 4096 characters max per value.

externalIdstring

Unique ID for a person from your or another external system, 256 characters max.

firstNamestring

Person's first name, 255 characters max.

gender'MALE' | 'FEMALE'

idinteger

Unique id of the entity.

lastNamestring

Person's last name, 255 characters max.

middleNamestring

Person's middle name, 50 characters max.

modifiedAtstring

Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.

preferredLanguagestring

Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.

profilePicturestring

URL for the person's profile picture, 2083 characters max.

tagsstring[]

List of tags that this person has.

type'CUSTOMER' | 'LEAD'

Response

successful response