Documentation
- Getting Started
- Authentication
- Making Requests
- Resource Creation
- Searching
- Plugins
- Webhooks
Tutorials
APIs
- Activity Codes
- Archive
- Authorization
- Bank Accounts
- Contacts
- Events
- Expenses
- Fees
- Files
- Firm
- Firm Users
- Folders
- Invoices
- Layout Designs
- Layout Matter Items
- Matter Billing Configuration
- Matter Items
- Matter Types
- Matters
- Memos
- Notifications
- Plugins
- Referral Types
- Relationships
- Roles
- Staff
- Stages
- Subscription Payments
- Subscription Promotions
- Subscriptions
- Tasks
- Users
- Webhooks
Roles
Add role to a matter
Appends a new role in the specified matter.
POST
/
matters
/
{matterId}
/
roles
curl --request POST \
--url https://api.smokeball.com/matters/{matterId}/roles \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "Provider",
"displayName": "Medical Provider",
"description": "Client",
"contactId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
"representativeIds": [
"776e778f-83df-454a-b344-768a862a7e67"
],
"isMatterItemRequired": true,
"relationships": [
{
"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"
}
Headers
Path Parameters
Body
Response
202
application/json
When request is accepted. Returns a hypermedia 'Link' object of the role to be created.
The response is of type object
.
curl --request POST \
--url https://api.smokeball.com/matters/{matterId}/roles \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "Provider",
"displayName": "Medical Provider",
"description": "Client",
"contactId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
"representativeIds": [
"776e778f-83df-454a-b344-768a862a7e67"
],
"isMatterItemRequired": true,
"relationships": [
{
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.