Idempotency

Our APIs support idempotency to help you safely retry requests without creating duplicates or causing unintended side effects.

When you send a request with an idempotency key, the API ensures that:

• The request is processed only once.
• Subsequent retries with the same key return the original response (success or error).
• No duplicate resources or repeated operations are created.

This is particularly useful in cases such as network failures, client retries, or uncertainty about whether a previous request was completed.

How it works

You generate a unique idempotency key on the client (for example, a UUID) and include it on the request using Idempotency-Key header.

POST /organization/v3/groups
Content-Type: application/json
Idempotency-Key: 68f96f93-2165-47c2-a497-f5600de5169c

{
    "name": "My section",
    "groupType": "SECTION",
    "parentGroupId": "1073741824",
}

Guidelines

• Uniqueness: Use a new idempotency key for each unique operation.
• Scope: Keys apply per account. Do not reuse keys
• Expiry: Idempotency keys are valid for 24 hours.
• Errors: If the original request failed due to a validation error, retries with the same key will return the same error.