Skip to main content
POST
/
blueprints
/
{blueprintId}
/
apply
Apply blueprint to bot
curl --request POST \
  --url https://api.helloannie.com/v1/blueprints/{blueprintId}/apply \
  --header 'Content-Type: application/json' \
  --data '
{
  "botId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "variables": {
    "office_name": "Happy Dental",
    "phone_number": {
      "value": "+15551234567",
      "createOrgVariable": true
    },
    "office_address": {
      "existingOrgVariableId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }
}
'
{
  "success": true,
  "data": {
    "jobId": "<string>",
    "templatesQueued": 123
  }
}

Path Parameters

​
blueprintId
string<uuid>
required

Body

Request body for applying a blueprint to a bot

​
botId
string<uuid>
required

The bot to apply the blueprint to

​
variables
object
required

Variable values keyed by variable name. Each value can be a plain string or an options object.

Example:
{
  "office_name": "Happy Dental",
  "phone_number": {
    "value": "+15551234567",
    "createOrgVariable": true
  },
  "office_address": {
    "existingOrgVariableId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Response

Response containing the blueprint apply job ID

​
success
enum<boolean>
required
Available options:
true
​
data
object
required