Use the response code and body together to decide what to do next. The API reference lists the responses for each endpoint.
| Code | Meaning | What to do |
|---|---|---|
200 OK |
The operation completed successfully. | Read the endpoint's documented response body. |
201 Created |
The API created the resource. | Check the response shape; it does not always contain an internalId. |
400 Bad request |
Required fields are missing, values are invalid, or a business rule prevents the operation. | Correct the request using the details in the response. |
| Authentication failed. The key may be missing, unknown, expired or suspended, or API access may be disabled. | Follow Troubleshoot authentication. | |
404 Not found |
The API could not find a requested object. | Check identifiers in both the URL and request body. |
422 Processing error |
The request has valid syntax, but the API could not process it. | Read the response body before deciding whether to retry. |
These are common responses, not an exhaustive list. Some endpoints document additional codes, including 409 conflicts and 502 partial failures.
Handling an error
Correct missing fields or invalid identifiers before sending the request again.
If a request times out, check whether the change succeeded before repeating a create or invitation request. A failed response does not always mean that no change took place.
For email changes, a documented 502 means the address changed but the invitation resend failed. Retry the invitation resend rather than repeating the email change.