API reference › General settings › Communication modes

Update an existing communication mode

PUT /v1/communication-modes/{communication_mode}

Scope
settings_general:edit

Update a communication mode by ID.

Parameters

Path parameters

NameTypeDescription
communication_mode requiredinteger

ID of the communication mode to update.

Example 5.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

FieldTypeDescription
name requiredstring

Example Updated Mode.

Example

JSON
{
  "name": "Updated Mode"
}

Example request

Shell
curl -X PUT "https://api.fetchfido.ai/v1/communication-modes/{communication_mode}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"Updated Mode"}'

Try it

Responses

200 Communication mode updated successfully

Communication mode updated successfully.

JSON
{
  "success": true,
  "message": "Communication Mode updated!",
  "data": {
    "id": 1,
    "value": 1,
    "label": "Example label",
    "isCustom": true
  }
}
Response fields (7)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Communication Mode updated!.

dataobject
data.idinteger

Example 1.

data.valueinteger

Example 1.

data.labelstring

Example Example label.

data.isCustomboolean

Example true.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'settings_general:edit' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_general:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Communication mode not found.

JSON
{
  "success": false,
  "message": "Communication mode with ID 5 not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Communication mode with ID 5 not found..

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal server error.

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.