v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

External Contacts

Create User Contact

Creates the user personal contact.

post/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

extensionIdstring required

Internal identifier of the RingCentral extension/user (can be set to "~" to indicate that the extension associated with current authorization session should be used)

Query parameters

dialingPlanstring

Country code value complying with the ISO 3166-1 alpha-2 format. The default value is home country of the current extension

Request body

firstNamestring

First name of a contact

lastNamestring

Last name of a contact

middleNamestring

Middle name of a contact

nickNamestring

Nick name of a contact

companystring

Company name of a contact

jobTitlestring

Job title of a contact

emailstring email

Email of a contact

email2string email

Second email of a contact

email3string email

Third email of a contact

birthdaystring date-time

Date of birth of a contact

webPagestring uri

Contact home page URL

notesstring

Notes for a contact

homePhonestring

Home phone number of a contact in e.164 (with "+") format

homePhone2string

Second home phone number of a contact in e.164 (with "+") format

businessPhonestring

Business phone of a contact in e.164 (with "+") format

businessPhone2string

Second business phone of a contact in e.164 (with "+") format

mobilePhonestring

Mobile phone of a contact in e.164 (with "+") format

businessFaxstring

Business fax number of a contact in e.164 (with "+") format

companyPhonestring

Company number of a contact in e.164 (with "+") format

assistantPhonestring

Phone number of a contact assistant in e.164 (with "+") format

carPhonestring

Car phone number of a contact in e.164 (with "+") format

otherPhonestring

Other phone number of a contact in e.164 (with "+") format

otherFaxstring

Other fax number of a contact in e.164 (with "+") format

callbackPhonestring

Callback phone number of a contact in e.164 (with "+") format

ringtoneIndexstring

Contact ringtone. Max number of symbols is 64

Example request

{
  "firstName": "Charlie",
  "lastName": "Williams",
  "middleName": "J",
  "nickName": "The Boss",
  "company": "Example, Inc.",
  "jobTitle": "CEO",
  "email": "charlie.williams@example.com",
  "email2": "charlie-example@gmail.com",
  "email3": "theboss-example@hotmail.com",
  "webPage": "http://www.example.com",
  "notes": "#1 Customer",
  "homePhone": "+15551234567",
  "homePhone2": "+15551234567",
  "businessPhone": "+15551234567",
  "businessPhone2": "+15551234567",
  "mobilePhone": "+15551234567",
  "businessFax": "+15551234567",
  "companyPhone": "+15551234567",
  "assistantPhone": "+15551234567",
  "carPhone": "+15551234567",
  "otherPhone": "+15551234567",
  "otherFax": "+15551234567",
  "callbackPhone": "+15551234567",
  "homeAddress": {
    "street": "20 Davis Dr.",
    "city": "Belmont",
    "state": "CA",
    "zip": "94002"
  },
  "businessAddress": {
    "street": "20 Davis Dr.",
    "city": "Belmont",
    "state": "CA",
    "zip": "94002"
  },
  "otherAddress": {
    "street": "20 Davis Dr.",
    "city": "Belmont",
    "state": "CA",
    "zip": "94002"
  }
}

Response

Created contact information

uristring uri

Canonical URI of a contact

availability'Alive' | 'Deleted' | 'Purged'

This property has a special meaning only on Address Book Sync (e.g. a contact can be Deleted). For simple contact list reading it has always the default value - Alive