customer-engagement

people

person-profile

Create a new person

Use this method to create a new person.

post/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

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.

modifiedFrom'API' | 'PORTAL' | 'WEB_SDK' | 'INTEGRATION' | 'PUSH' | 'FACEBOOK' | 'LINE' | 'TELEGRAM' | 'SALESFORCE' | 'DYNAMICS' | 'ZAPIER' | 'FORMS' | 'COMPUTED' | 'ANSWERS' | 'CONVERSATIONS'

origin'API' | 'PORTAL' | 'WEB_SDK' | 'INTEGRATION' | 'PUSH' | 'FACEBOOK' | 'LINE' | 'TELEGRAM' | 'SALESFORCE' | 'DYNAMICS' | 'ZAPIER' | 'FORMS' | 'COMPUTED' | 'ANSWERS' | 'CONVERSATIONS'

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

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.

modifiedFrom'API' | 'PORTAL' | 'WEB_SDK' | 'INTEGRATION' | 'PUSH' | 'FACEBOOK' | 'LINE' | 'TELEGRAM' | 'SALESFORCE' | 'DYNAMICS' | 'ZAPIER' | 'FORMS' | 'COMPUTED' | 'ANSWERS' | 'CONVERSATIONS'

origin'API' | 'PORTAL' | 'WEB_SDK' | 'INTEGRATION' | 'PUSH' | 'FACEBOOK' | 'LINE' | 'TELEGRAM' | 'SALESFORCE' | 'DYNAMICS' | 'ZAPIER' | 'FORMS' | 'COMPUTED' | 'ANSWERS' | 'CONVERSATIONS'

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'

Changes

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