Templates

List templates

List one project's custom templates (see profile_id) with available channels, message types, and variables. Templates exist only per project; an account with no project yet lists none.

get/api/v1/templates

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/templates
  • Auth: HTTP bearer

Query parameters

profile_idstring

The sub-account (project) whose templates to act on — templates exist only per project. A project-bound API key acts for its own project only; naming another answers 403 profile_mismatch (SEC-SA-002). An account-wide key or a dashboard session may name any project of the account (403 profile_not_owned otherwise). Omitted: the key's project, else the primary project.

Example:507f1f77bcf86cd799439011

Response

Templates with metadata

profile_idstring

MongoDB ObjectId

available_channelsTemplateChannel[] required
available_message_typesMessageType[] required

Example response

{
  "profile_id": "507f1f77bcf86cd799439011",
  "custom_templates": [
    {
      "id": "507f1f77bcf86cd799439011",
      "profile_id": "507f1f77bcf86cd799439011",
      "channel": "email",
      "message_type": "verification_request"
    }
  ],
  "available_channels": [
    "email"
  ],
  "available_message_types": [
    "verification_request"
  ],
  "available_variables": [
    {
      "name": "business_name",
      "description": "Your business display name"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.