Partner Workflows

Account status

Check whether a Scribeless account is ready for API-driven sending.

Check whether the account connected to an API key is ready to list templates, create campaigns, and complete approved partner billing setup.

GET https://platform.scribeless.co/api/account/status

This endpoint is most useful for approved partner integrations that provision or operate customer accounts. To become an approved partner, contact the Scribeless team.

Headers

X-API-Key: YOUR_API_KEY

Query parameters

Parameter	Type	Description
`billingRedirectUrl`	string	Optional HTTPS URL in your app where Scribeless should send the customer after invoice billing setup. Maximum length is 500 characters.

Example request

curl --request GET 'https://platform.scribeless.co/api/account/status?billingRedirectUrl=https%3A%2F%2Fpartner.example.com%2Fscribeless%2Fbilling-return' \
  --header 'X-API-Key: CUSTOMER_TEAM_API_KEY'

Response

Successful requests return readiness flags for the API key's team.

{
  "teamId": "TEAM_ID",
  "templatesReady": true,
  "billByInvoice": false,
  "canListTemplates": true,
  "canCreateCampaigns": true,
  "canCreateRecurringCampaign": false,
  "billingSetupUrl": "https://platform.scribeless.co/partner-checkout?sessionId=CHECKOUT_SESSION_SECRET",
  "links": {
    "templatesUrl": "https://platform.scribeless.co/templates"
  }
}

Fields

Field	Type	Description
`teamId`	string	Scribeless team ID for the API key.
`templatesReady`	boolean	Whether the team has templates ready for campaign creation.
`billByInvoice`	boolean	Whether approved partner invoice billing is ready for this team.
`canListTemplates`	boolean	Whether the API key can list templates.
`canCreateCampaigns`	boolean	Whether the team can create campaigns through the API.
`canCreateRecurringCampaign`	boolean	Whether the team can create recurring campaigns through the API. This is `true` when the team has templates and a recurring subscription configured.
`billingSetupUrl`	string	Setup URL for approved partner invoice billing, when setup is required. This field is omitted when setup is not required. If `billingRedirectUrl` is provided, this URL uses partner checkout so Scribeless can redirect the customer back to your app after setup.
`links.templatesUrl`	string	Platform URL where the team can manage templates.

Account readiness phases

Use the response to decide which setup step the customer needs next.

Phase	How to identify	Meaning	Partner action
Newly provisioned	`templatesReady: false`, `canCreateCampaigns: false`, `billingSetupUrl` present	The team exists and the API key works, but setup is incomplete.	Store the `teamId` and API key. Send the customer to billing setup and template setup.
Billing ready, templates missing	`templatesReady: false`, `canCreateCampaigns: false`, no `billingSetupUrl`	Billing is configured, but no usable published template exists yet.	Send the customer to the templates page.
Templates ready, billing setup needed	`templatesReady: true`, `canCreateCampaigns: true`, `billingSetupUrl` present	Campaigns can be created, but payment setup may still be required before fulfilment.	Allow campaign and recipient setup, then send the customer through checkout before fulfilment.
One-time invoice ready	`templatesReady: true`, `billByInvoice: true`, `canCreateCampaigns: true`	The customer can use invoice-billed one-time campaigns.	Create a one-time campaign with `frequency: "oneTime"`, add recipients, then call `POST /api/recipients/checkout`.
Recurring ready	`templatesReady: true`, `canCreateRecurringCampaign: true`	The customer has a recurring subscription configured.	Create recurring campaigns. You do not need to call checkout recipients for recurring campaign billing.

Usage

If templatesReady or canCreateCampaigns is false, ask the customer to finish template setup in Scribeless.
If billingSetupUrl is present, the customer needs to complete billing setup before invoice-billed partner checkout can complete.
Send billingRedirectUrl when you want billing setup checkout to return the customer to your app.
Do not store billingSetupUrl permanently. Fetch account status again before sending the customer back to setup.

Status codes

Status	Meaning
`200`	Account status returned.
`400`	Invalid `billingRedirectUrl`.
`401`	Missing, malformed, invalid, or unauthorized API key.
`500`	Account status could not be checked. Retry or contact support if it persists.

Create partner team

Provision a Scribeless customer team from an approved partner account.

Default templates

Create a default published template for a customer team.