question

new_dev avatar image
new_dev asked ·

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

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?

topic-default
1 |1000 characters needed characters left characters exceeded

Up to 8 attachments (including images) can be used with a maximum of 1.0 MiB each and 10.0 MiB total.

Byrne Reese avatar image
Byrne Reese answered ·

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"
}
Share
1 |1000 characters needed characters left characters exceeded

Up to 8 attachments (including images) can be used with a maximum of 1.0 MiB each and 10.0 MiB total.

benjamin-dean avatar image
benjamin-dean answered ·
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.
2 comments Share
1 |1000 characters needed characters left characters exceeded

Up to 8 attachments (including images) can be used with a maximum of 1.0 MiB each and 10.0 MiB total.

Contact API still in the works?
0 Likes 0 · ·
Hi Jason,

We do have the Address Book API where you could retrieve the contacts from the Personal Address Book as well as create/update new contacts. 

Since this is a Beta API, you would need to send an email to devsupport@ringcentral.com requesting the same and we could provide the necessary access to view this Beta API.
0 Likes 0 · ·
edward-wilde avatar image
edward-wilde answered ·
Is this address book api released? Is there documentation for it?

Thanks,

Ed.
Share
1 |1000 characters needed characters left characters exceeded

Up to 8 attachments (including images) can be used with a maximum of 1.0 MiB each and 10.0 MiB total.

hudson-dental-center avatar image
hudson-dental-center answered ·
Is this released yet?
Share
1 |1000 characters needed characters left characters exceeded

Up to 8 attachments (including images) can be used with a maximum of 1.0 MiB each and 10.0 MiB total.