Solved

Can you add a contact name / number to an organization via the API?

  • 5 July 2016
  • 4 replies
  • 2581 views

Is it possible to add a new contact (a name and number for example) via the API so when a customer signs up there info is automatically added to RingCentral so if and when they call we have their name to show on the screen?

icon

Best answer by ByrneReese 25 June 2019, 17:31

View original

4 replies

We do have an address book API in beta which would support this functionality. If you are interested in joining this beta, please submit a Developer Support Case. Please provide a clear and detailed use-case (how you plan on using this API resource, estimated number of requests hourly, and the data you expect to have available or be able to save) for requesting access to this API resource, the name of your application, and the APP ID.

Our engineering team will review this request for viability and if approved, enable this for your specific application.
Is this address book api released? Is there documentation for it?

Thanks,

Ed.
Is this released yet?

The Address Book API has been released. You can use the createContact endpoint to create contacts within your organization. Here is a sample request and response for adding a contact that is available to everyone in your organization:

Sample Request

POST /restapi/v1.0/account/~/extension/~/address-book/contact

{
  "firstName": "Charlie",
  "lastName": "Williams",
  "businessPhone": "+15551234567",
  "businessAddress": {
    "street": "20 Davis Dr.",
    "city": "Belmont",
    "state": "CA",
    "zip": 94002
  }
}

Sample Response

HTTP 200 OK

{
  "uri": "https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004",
  "availability": "Alive",
  "id": 623045004,
  "firstName": "Charlie",
  "lastName": "Williams",
  "businessAddress": {
    "street": "20 Davis Dr.",
    "city": "Belmont",
    "state": "CA",
    "zip": 94002
  },
  "businessPhone": "+15551234567"
}

Reply