Service Guides for ResourceIQ

Investigate use cases. Find sample scenarios. Learn how your applications can best use ResourceIQ.

Create a Contact

The create contact endpoint allows you to create a contact to represent a person and their contact details. The contact details are described by a JSON schema.

To Create a Contact (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • Define the contact details payload. More information on the elements in the contact details payload can be found in the ContactWrapperPayload definition.

Request

POST https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/contact
Body Request Parameter

{
  "extensionObject": {
    "status": "active",
    "objectType": "contact",
    "objectDescription": "This is a contact object."
  },
  "contactPoint": {
    "name": "John Frederick",
    "telephone": "1234567890",
    "contactType": "Sales",
    "email": "jFrederick@ebsco.com",
    "description": "This contact point is for a salesperson at EBSCO."
  },
  "organization": {
    "name": "EBSCO Publishing",
    "address": {
      "streetAddress": "1600 Amphitheatre Pkwy",
      "addressLocality": "Mountain View",
      "addressRegion": "CA",
      "addressCountry": "USA",
      "postalCode": "94043"
    }
  },
  "contact": {
    "designation": "string"
  }
}


Response

201 CREATED

{
  "contactId": "065cb541-681c-4dd9-a059-e78b72e31bc4",
  "errors": [],
  "successful": true
}

For more information on the POST create a contact resource, please refer to our interactive or service reference documentation.