Skip to main content
POST
/
integrations
/
v2
/
resource-records
Create Resource Record
curl --request POST \
  --url https://api-qa.interactly.ai/integrations/v2/resource-records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "logicalId": "<string>",
  "integrationId": "5eb7cf5a86d9755df3a6c593",
  "config": {
    "type": "practitioners",
    "organizationId": "<string>",
    "id": "<string>",
    "name": "<string>",
    "gender": "<string>",
    "avatar": "<string>",
    "summary": "<string>",
    "status": "active",
    "languages": [
      "<string>"
    ],
    "specialties": [
      {
        "name": "<string>",
        "code": "<string>"
      }
    ],
    "locations": [
      {
        "locationId": "<string>",
        "locationName": "<string>"
      }
    ],
    "preferred_visiting_reasons": [
      "5eb7cf5a86d9755df3a6c593"
    ]
  }
}
'
{
  "integration_resource_record": {
    "teamId": "5eb7cf5a86d9755df3a6c593",
    "createdBy": "5eb7cf5a86d9755df3a6c593",
    "updatedBy": "5eb7cf5a86d9755df3a6c593",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "_id": "5eb7cf5a86d9755df3a6c593",
    "logicalId": "<string>",
    "integrationId": "5eb7cf5a86d9755df3a6c593",
    "config": {
      "type": "practitioners",
      "organizationId": "<string>",
      "id": "<string>",
      "name": "<string>",
      "gender": "<string>",
      "avatar": "<string>",
      "summary": "<string>",
      "status": "active",
      "languages": [
        "<string>"
      ],
      "specialties": [
        {
          "name": "<string>",
          "code": "<string>"
        }
      ],
      "locations": [
        {
          "locationId": "<string>",
          "locationName": "<string>"
        }
      ],
      "preferred_visiting_reasons": [
        "5eb7cf5a86d9755df3a6c593"
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json
​
logicalId
string | null

Unique identifier for the integration resource record

​
integrationId
string | null

Reference to the associated integration

Required string length: 24
Example:

"5eb7cf5a86d9755df3a6c593"

​
config
AthenaResourcesPractitionersConfig · object

Configuration for Athena Practitioners resource records.

Response

Successful Response

Response model for a single integration resource record. Contains a IntegrationsResourceRecordsModel object.

​
integration_resource_record
IntegrationsResourceRecordsModel · object
required

Single integration resource record object