API reference › Service setup › Service provider types
Create a new service provider type
POST /v1/service-provider-types
- Scope
settings_service_setup:write- Roles
- admin, scheduler
Create a new service provider type with a name and optional tenant ID.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
name required | array of object | One or more provider types to create. |
name[].id | integer | Example |
name[].label | string | Example |
serviceType | object | The service type the provider types belong to. Required unless customServiceType is sent. |
serviceType.id | integer or string | Example |
serviceType.label | string or null | Example |
customServiceType | string or null | Creates a new service type with this name. Required unless serviceType is sent. Example |
Example
{
"name": [
{
"id": 1,
"label": "Certified Interpreter"
}
],
"serviceType": {
"id": 1,
"label": "Example"
},
"customServiceType": "Captioning"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/service-provider-types" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":[{"id":1,"label":"Certified Interpreter"}],"serviceType":{"id":1,"label":"Example"},"customServiceType":"Captioning"}'Try it
Responses
201 Service Provider Type created successfully
Service Provider Type created successfully.
{
"success": true,
"message": "Service Provider Type created!",
"data": {
"id": 2,
"name": "Certified Interpreter",
"isCustom": true
}
}Response fields (6)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | integer | Example |
data.name | string | Example |
data.isCustom | boolean | Example |
400 Bad request
Validation failed.
{
"success": false,
"message": "The name field is required."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'settings_service_setup:write' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal server error.
{
"success": false,
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |