API reference › General settings › Identities

Create one or more identities

POST /v1/identities

Scope
settings_general:write
Roles
admin, scheduler

Add custom identities to the organization's list. Entries added here are custom (isCustom true) and can be renamed or deleted.

Parameters

None of its own.

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

Request body required

FieldTypeDescription
name requiredarray of object

One or more entries to add. Multipart requests may send it as a JSON string.

name[].label requiredstring

max length 255. Example Late-deafened.

Example

JSON
{
  "name": [
    {
      "label": "Late-deafened"
    }
  ]
}

Example request

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

Try it

Responses

201 Identity created successfully

Identity created successfully.

JSON
{
  "success": true,
  "message": "Custom identity Late-deafened (10) has been saved successfully.",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Custom identity Late-deafened (10) has been saved successfully..

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:write' 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:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation failed (missing name, a name already on the list in any case, or the same name given twice in one request).

JSON
{
  "status": "error",
  "message": "We couldn't save this identity. Correct the highlighted fields and try again.",
  "errors": {
    "name": [
      "This identity already exists."
    ]
  }
}
Response fields (3)
FieldTypeDescription
statusstring

Example error.

messagestring

Example We couldn't save this identity. Correct the highlighted fields and try again..

errorsobject

Messages keyed by the field they belong to; every entry's message lands on name.

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 .