RIringcentral
External Contacts

Upload Multiple User Contacts

Uploads multiple contacts for multiple extensions at once. Maximum 500 extensions can be uploaded per request. Max amount of contacts that can be uploaded per extension is 10,000. Each contact uploaded for a certain extension is not visible to other extensions.

post/restapi/v1.0/account/{accountId}/address-book-bulk-upload

Request

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)

Request body

Example request

{
  "records": [
    {
      "contacts": [
        {
          "email": "charlie.williams@example.com",
          "notes": "#1 Customer",
          "company": "Example, Inc.",
          "firstName": "Charlie",
          "lastName": "Williams",
          "jobTitle": "CEO",
          "webPage": "http://www.example.com",
          "middleName": "J",
          "nickName": "The Boss",
          "email2": "charlie-example@gmail.com",
          "email3": "theboss-example@hotmail.com",
          "homePhone": "+15551234567",
          "homePhone2": "+15551234567",
          "businessPhone": "+15551234567",
          "businessPhone2": "+15551234567",
          "mobilePhone": "+15551234567",
          "businessFax": "+15551234567",
          "companyPhone": "+15551234567",
          "assistantPhone": "+15551234567",
          "carPhone": "+15551234567",
          "otherPhone": "+15551234567",
          "otherFax": "+15551234567",
          "callbackPhone": "+15551234567"
        }
      ]
    }
  ]
}

Response

Accepted

idstring required

Internal identifier of a task

uristring uri required

Link for the task status retrieval

status'Accepted' | 'InProgress' | 'Completed' | 'Failed' required

Task status

creationTimestring date-time required

Date/time of a task creation

lastModifiedTimestring date-time required

Date/time of a task latest update

Example response

{
  "results": {
    "affectedItems": [
      {
        "contacts": [
          {
            "email": "charlie.williams@example.com",
            "notes": "#1 Customer",
            "company": "Example, Inc.",
            "firstName": "Charlie",
            "lastName": "Williams",
            "jobTitle": "CEO",
            "webPage": "http://www.example.com",
            "middleName": "J",
            "nickName": "The Boss",
            "email2": "charlie-example@gmail.com",
            "email3": "theboss-example@hotmail.com",
            "homePhone": "+15551234567",
            "homePhone2": "+15551234567",
            "businessPhone": "+15551234567",
            "businessPhone2": "+15551234567",
            "mobilePhone": "+15551234567",
            "businessFax": "+15551234567",
            "companyPhone": "+15551234567",
            "assistantPhone": "+15551234567",
            "carPhone": "+15551234567",
            "otherPhone": "+15551234567",
            "otherFax": "+15551234567",
            "callbackPhone": "+15551234567"
          }
        ]
      }
    ]
  }
}

Changes

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