POST
/
matters
/
{matterId}
/
roles
/
{roleId}
/
relationships
curl --request POST \
  --url https://api.smokeball.com/matters/{matterId}/roles/{roleId}/relationships \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "Provider",
  "displayName": "Medical Provider",
  "contactId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "representativeIds": [
    "776e778f-83df-454a-b344-768a862a7e67"
  ],
  "isMatterItemRequired": true
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Headers

​
Version
integer

Path Parameters

​
matterId
string
required
​
roleId
string
required

Body

Response

202
application/json

When request is accepted. Returns a hypermedia 'Link' object of the relationship to be created.

The response is of type object.