Copy page

Error codes

custom_field_not_found

Custom field not found. Keys of custom_fields must be the names of custom fields defined in the console (Contacts, Custom fields). The API does not create fields on the fly, so a typo cannot silently create a new field.

What it means

The API returns HTTP 422 with error.code set to custom_field_not_found. The default message is: "This custom field does not exist in the workspace."

Common causes

• A typo in a custom field name.
• The field was deleted or never created.

How to identify it

Check the response status (422) and error.code (custom_field_not_found). Branch on error.code, not on the message text: messages can be reworded, codes do not change within v1. Log error.request_id (also sent as the X-Request-Id header) so support can find the request.

How to fix it

• Create the field in the console, or correct the key named in details.field.

Retry guidance

Sending the request unchanged fails the same way. Fix the cause first (see How to fix it), then send it again.

Did anything happen?

This request was refused before any call was placed and before anything was charged.

Idempotency

Nothing was done and the refusal is not stored under the Idempotency-Key. Fix the cause, then send the same request (with the same key if you sent one).

Who can fix it

The developer who sends the request can fix it; no administrator action is normally needed.

When to contact support

If the error persists after the steps above, contact support@relationsai.com. See Support for what to include (the request_id, the time in UTC, the operation, and whether you used a test or live key) and what never to send (API keys, Authorization headers, webhook signing secrets, recording links, transcripts or customer data).

Example error response

JSON
{
  "error": {
    "code": "custom_field_not_found",
    "message": "This custom field does not exist in the workspace.",
    "details": {
      "field": "policy_numbr"
    },
    "request_id": "req_z6vplhqdzobjbgdbzq724ujk",
    "retry": "no",
    "doc_url": "https://docs.relationsai.com/errors/custom_field_not_found"
  }
}

Incorrect and corrected request

Incorrect: policy_numbr is not a custom field of the workspace.

Text
POST /v1/contacts

{
  "phone_number": "+12025550101",
  "custom_fields": {
    "policy_numbr": "PN-55012"
  }
}

Corrected: The key names the field exactly as defined in the console.

Text
POST /v1/contacts

{
  "phone_number": "+12025550101",
  "custom_fields": {
    "policy_number": "PN-55012"
  }
}

Operations that can return this error

• POST /contacts: Create a contact
• POST /contacts/upsert: Create or update a contact by phone number
• PATCH /contacts/{contact_id}: Update a contact

See all codes in the error-code reference.