Log inTry for free
Back to all APIs

Add contact information to person

Use this method to add emails and mobile phones to a particular person.

Please log in to see full path URL. Learn why.
patch
/people/2/persons/contactInformation
Authorizations:
API Key Header
Basic
IBSSO Token Header
OAuth 2
Scopes:
people:manage
Request rate limit:
5 requests / second (per account)
query Parameters
identifier
string
Example: identifier=370329180020364

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

sender
string
Example: sender=2094832040560427

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

type
string
Enum: "ID" "EXTERNAL_ID" "PHONE" "EMAIL" "LINE" "FACEBOOK" "TELEGRAM" "PUSH" "WEB_PUSH" "LIVE_CHAT" "VIBER_BOTS" "INSTAGRAM" "INSTAGRAM_DM" "TWITTER" "APPLE_BUSINESS_CHAT" "KAKAO_SANGDAM" "OPEN_CHANNEL"
Example: type=PHONE

Type of the person ID

Request Body schema:
application/json
collapse all -
contactInformation
required
object

Person's contact information

email
Array of objects

A list of person's email addresses. Max 100 emails per person.

Array
address
string

Person's email address. Must comply with the email format and cannot exceed 255 characters. One person can have up to 100 email addresses.

phone
Array of objects

A list of person's phone numbers. Max 100 numbers per person.

Array
number
string

Person's phone number. Must be in international format and cannot exceed 50 characters. One person can have up to 100 phone numbers.

Responses

default

successful response

400

Bad Request

401

Unauthorized

403

Forbidden

429

Too Many Requests

4XX

Error responses

500

Internal Server Error

5XX

Error responses

Request samples

Content type
application/json
Copy
 Collapse all
{
  • "contactInformation":
    {
    • "email":
      [
      • {
        • "address": "string"
        }
      ],
    • "phone":
      [
      • {
        • "number": "string"
        }
      ]
    }
}

Response samples

Content type
application/json
Copy
 Collapse all
{
  • "createdAt": "2018-03-29T13:46:31",
  • "modifiedAt": "2018-03-30T11:25:13",
  • "id": 1,
  • "externalId": "3",
  • "firstName": "Jane",
  • "lastName": "Smith",
  • "address": "67 Farringdon Road",
  • "city": "London",
  • "country": "United Kingdom",
  • "gender": "FEMALE",
  • "birthDate": "1966-01-15",
  • "middleName": "Janie",
  • "preferredLanguage": "en-gb",
  • "profilePicture": "http://profile.com",
  • "origin": "API",
  • "modifiedFrom": "API",
  • "tags":
    [
    • "VIP Customers",
    • "New Customers"
    ],
  • "customAttributes":
    {
    • "Contract Expiry": "2018-06-01",
    • "Company": "Acme",
    • "ShoppingCartList":
      [
      • {
        • "productName": "Sneakers",
        • "productPrice": 25.33,
        • "productCategory": "Sport Sneakers",
        • "productImage": "/image1.png"
        },
      • {
        • "productName": "T-Shirt",
        • "productPrice": 9.99,
        • "productCategory": "Casual",
        • "productImage": "/image2.png"
        }
      ]
    },
  • "contactInformation":
    {
    • "phone":
      [
      • {
        • "number": "41793026727"
        }
      ],
    • "email":
      [
      • {
        • "address": "janewilliams@acme.com"
        }
      ],
    • "push":
      [
      • {
        • "applicationId": "FDCC8516470A3AE97FB8AC218D5D0D3D",
        • "registrationId": "c5db0c47-465c-4e1c-abf8-7cedc275dd19",
        • "additionalData":
          {
          • "birthdate": "1988-07-31",
          • "email": "test@test.com",
          • "firstName": "Jane",
          • "gender": "F",
          • "lastName": "Smith",
          • "middleName": "Janie"
          },
        • "systemData":
          {
          • "cloudType": "GCM",
          • "registrationEnabled": "true",
          • "sdkName": "MobileMessaging SDK",
          • "os": "Android"
          }
        }
      ],
    • "facebook":
      [
      • {
        • "applicationId": "370329180020364",
        • "userId": "2094832040560427",
        • "systemData":
          {
          • "gender": "female",
          • "lastName": "Smith",
          • "firstName": "Jane"
          }
        }
      ],
    • "line":
      [
      • {
        • "applicationId": "1644264921",
        • "userId": "U045147f1ad961bfe996b72bbf417f3c9",
        • "systemData":
          {
          • "displayName": "Jane Smith"
          }
        }
      ],
    • "instagram":
      [
      • {
        • "applicationId": "17841446795352028",
        • "userId": "12461436693342628",
        • "systemData":
          {
          • "displayName": "jane.smith"
          }
        }
      ],
    • "twitter":
      [
      • {
        • "applicationId": "1148203323283877",
        • "userId": "370329180020364",
        • "systemData":
          {
          • "displayName": "Jane Smith"
          }
        }
      ],
    • "appleBusinessChat":
      [
      • {
        • "applicationId": "387465931",
        • "userId": "387465931",
        • "systemData":
          {
          • "displayName": "Jane Smith"
          }
        }
      ]
    }
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.

Privacy documentsTerms of use