Update an entity

PATCH

/entities/{id}

Updates one or more mutable fields on an existing entity. Only the fields you include in the request body are changed — omitted fields retain their current values. The identity must have can_edit_entity or wildcard * ACL access to the entity.

The immutable fields (name, client_reference, type, category, country) cannot be changed after creation.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Entity updated successfully. Returns the full updated entity object.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

Request Example

Shell

JavaScript

Java

Swift

cURL

Update email onlyUpdate multiple fields

curl --location --request PATCH '/entities/01JABC1234567890ABCDEFGHIJ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "new-contact@acmecorp.ng"
}'

Response Example

200 - Success

{
    "message": "Entity updated successfully",
    "status": "success",
    "data": {
        "id": "01JABC1234567890ABCDEFGHIJ",
        "parent_id": null,
        "name": "Acme Corp Nigeria",
        "client_reference": "ent-ng-001",
        "client_label": "Acme Lagos",
        "type": "business",
        "category": "retail",
        "email": "new-contact@acmecorp.ng",
        "mobilenumber": "+2348099998888",
        "country": "NG",
        "status": "approved",
        "identity_id": "01JIDENT234567890ABCDEFGHI",
        "entity_logo": "https://cdn.acmecorp.ng/logo.png",
        "client_meta": {
            "crm_id": "crm-9900",
            "region": "north"
        }
    }
}

Modified at 2026-09-30 00:29:30

Close an entity

Retrieve an entity