Skip to main content
Solved

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?

Best answer by ByrneReese

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"
}
View original

6 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.

  • New Participant
  • 1 reply
  • September 7, 2017
Is this address book api released? Is there documentation for it?

Thanks,

Ed.

Is this released yet?

ByrneReese
Community Manager
Forum|alt.badge.img+3
  • Product Manager
  • 255 replies
  • Answer
  • June 25, 2019

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"
}

  • New Participant
  • 2 replies
  • December 18, 2024

Hello,
@ByrneReese when using this endpoint, it create the contact linked to a specific extension of a user, even if I use the “account/~/extension/~/".

Could you maybe help with this issue ?


ByrneReese
Community Manager
Forum|alt.badge.img+3
  • Product Manager
  • 255 replies
  • December 19, 2024

@Eml29 The above is over 5 years old. It is possible that it is in error. Now that I am little more experienced and knowledgable of our APIs, I can say that the address book API only adds personal contacts. But some changes coming in 2025 to the address book API might change this. Stay tuned. 


Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings