API reference › General settings › Identities

Rename a custom identity

PUT /v1/identities/{identity}

Scope
settings_general:edit
Roles
admin, scheduler

Rename a custom identity by ID. Default entries (isCustom false) can't be renamed.

Parameters

Path parameters

NameTypeDescription
identity requiredinteger

ID of the identity to update.

Example 10.

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

Request body required

FieldTypeDescription
name requiredstring

max length 255. Example Late-deafened community.

Example

JSON
{
  "name": "Late-deafened community"
}

Example request

Shell
curl -X PUT "https://api.fetchfido.ai/v1/identities/{identity}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"Late-deafened community"}'

Try it

Responses

200 Identity updated successfully

Identity updated successfully.

JSON
{
  "success": true,
  "message": "Changes to custom identity Late-deafened community (10) were saved.",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Changes to custom identity Late-deafened community (10) were saved..

dataobject or null
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 .

422 Validation failed

An unknown id, or a missing or taken name (the form shape, with status); or an archived entry or a default (the envelope, with success).

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields",
  "errors": {
    "name": "Default identities can't be renamed."
  },
  "code": ""
}
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!",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.

errorsstring or null

The underlying error, in debug mode only.

codestring

Example .