Action

Get organization actions

get

Retrieves organization actions

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters
resourceTypestring · enumOptionalPossible values:
rolestring · enumOptionalPossible values:
appointmentTypeTemplateIdnumberOptional
locationTypestring · enumOptionalPossible values:
enableRoutesbooleanOptional
takenumberOptional
Responses
chevron-right
200Success
application/json
get
/api/organization/action
200Success

Create organization action

post

Creates a new organization action

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body
namestringRequired
descriptionstringOptional
ordernumber · min: 1Required
organizationIdnumberRequired
resourceTypestring · enumRequiredPossible values:
labelstring · enumOptionalPossible values:
nextActionIdsnumber[]Optional
appointmentTypeTemplateIdnumberOptional
locationTypestring · enumOptionalPossible values:
durationnumberOptional
enableRoutesbooleanOptional
Responses
chevron-right
200Success
application/json
post
/api/organization/action
200Success

Get organization action by ID

get

Retrieves a specific organization action

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Responses
chevron-right
200Success
application/json
get
/api/organization/action/{id}
200Success

Update organization action

put

Updates an existing organization action

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Body
namestringOptional
descriptionstringOptional
ordernumber · min: 1Optional
organizationIdnumberOptional
resourceTypestring · enumOptionalPossible values:
nextActionIdsnumber[]Optional
durationnumberOptional
enableRoutesbooleanOptional
Responses
chevron-right
200Success
application/json
put
/api/organization/action/{id}
200Success

Delete organization action

delete

Deletes an organization action

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Responses
chevron-right
200Success
application/json
delete
/api/organization/action/{id}
200Success

Was this helpful?