Create an approval request

post

https://api.convert.com/api/v2/accounts/{account_id}/approval-requests/add

Creates a new approval request in pending state for the given entity action. Returns
409 Conflict (with the existing request's id in the error context) if a pending request
already exists for the same account, entity type, entity id, rule code, and submitter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the approval request.

Body Params

Creates a new approval request in pending state for the given entity action.

Payload to create a new approval request.

entity_type

string

enum

required

Type of entity an approval rule or request applies to (e.g., experience).

Allowed:

entity_id

string

required

ID of the entity being acted on.

project_id

string | null

ID of the project that owns the entity being acted on, or null when the entity is not project-scoped. Required for project-scoped entity types.

rule_code

string

enum

required

Code of a predefined approval rule. Each value maps to an entity type and a specific
action (e.g., experience.activate).

Allowed:

context

string

Optional context to provide background for the approver.

Responses

200A single approval request.

409Indicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.