Create Blueprint

post

https://api.authvia.com/v3/accounts/{account-id}/blueprints

scope `blueprints:create`

Create a new Blueprint for the specified Account. This endpoint allows you to define reusable business process templates.

Info

Blueprints provide predefined templates and workflows that can streamline your business process creation and ensure consistency across your applications.

You can configure actions, themes, and other settings during creation or update them later.

Tip: Use blueprints to standardize common business processes like payment flows, customer onboarding, or document collection.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account-id

string

required

The unique identifier (AVID) of the Account.

Body Params

Payload for creating a blueprint

name

string

required

length ≥ 1

The blueprint name must be unique within an account (merchant), as its slugified version becomes the blueprint's unique identifier.

idSeed

string

Generates unique-deterministic id based on this value and merchant avid, if any business-process already exists with this value, it will return an error.

customer

string

required

length ≥ 1

Dynamic variable The unique customer reference that will receive the created business process.

description

string

required

length ≥ 1

The blueprint description outlines its purpose and intent, detailing the specific business needs it aims to fulfill.

expiration

string

Dynamic variable The expiration period of the business process starts from its creation time, with a default duration of 45 days, represented as 45d.

theme

object

Customizes the visual appearance of the blueprint in the user interface. The theme object accepts the following properties:

name: The friendly name of the merchant shown to the customer
color: A hex color code for the primary theme color
logo: An icon identifier (e.g., Material Design Icons) for the logo
banner: URL to a banner image (recommended size: 1200x630px)
image: URL to a profile picture (recommended size: 180x180px) All properties are optional and can be used to create a branded experience for the blueprint.

sequence

number

The sequence will affect how the blueprints are ordered and displayed within our applications.

schedule

string | number

Dynamic variable A schedule facilitates the creation of a business process at a specified future time, provided in epoch format during real-time execution.

callback

string

Dynamic variable A callback facilitates as a webhook URL which will be invoked when the business process is created and resolved/failed.

actions

string | array

required

A list of business process actions in the blueprint. The order of these actions is critical for rendering messages or web experiences for customers. Each action must be defined according to the specifications in the Action Catalog section.

Responses

201Successfully created blueprint. Returns the complete blueprint details including actions and configuration.

400Bad Request - The request cannot be processed due to a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401The request is valid, but server authentication failed to verify the identity. The user's access token has either expired or is not valid. Creating a new token might resolve the issue.