White label

Run Ready under your own name. These calls do what the White label card on the Partner page does, with the same permissions: the account that runs white label, or an admin seat of it, with the Manage team permission to change anything. A key acting as a sub-account with X-Sub-Account-Id gets not_agency_owner. Joining white label, signing the agreement and paying the monthly fee stay on the Partner page. To stop white label, email legal@tryready.com 30 days ahead. The Platform Fee for those 30 days is still charged.

#Get your brand

Your white label brand as the White label card on the Partner page shows it: name, logo, color, custom domain and whether it is live. Only the account that runs white label, or an admin seat of it, can read it.

Errors

HTTP	Code	When
403	`not_agency_owner`	The key is not for the white label account itself or an admin seat of it, or it acts as a sub-account.
404	`no_brand`	This account has not joined white label yet.

curl "https://api.tryready.com/v1/white-label" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/white-label', {
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/v1/white-label",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "name": "Acme Texting",
    "logo_url": "https://example.com/logo.png",
    "primary_color": "#1a73e8",
    "support_email": "help@acme.example.com",
    "domain": "app.acme.example.com",
    "domain_status": "active",
    "white_label_enabled": true,
    "dns_records": null
  }
}

#Set your brand

Changes your brand name, logo or color. Send only the fields you want to change. Needs the Manage team permission (invite_team). Upload a logo with Upload your logo and send its url as logo_url. The on and off switch and the support email stay with Ready. Answers 402 fee_unpaid until the first month of white label is paid on the Partner page.

Parameters

namestring: The brand name your sub-accounts see.
logo_urlstring: The url of your logo.
primary_colorstring: Your main color, for example #1a73e8.

Errors

HTTP	Code	When
403	`not_agency_owner`	The key is not for the white label account itself or an admin seat of it, or it acts as a sub-account.
403	`needs_team_access`	The key’s seat does not have the Manage team permission.
400	`nothing_to_change`	No field was sent.
402	`fee_unpaid`	The first month of white label isn’t paid yet. Pay it in white label setup on the Partner page, then send this again.
404	`no_brand`	This account has not joined white label yet.

curl -X PUT "https://api.tryready.com/v1/white-label" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Texting",
    "primary_color": "#1a73e8"
  }'

const res = await fetch('https://api.tryready.com/v1/white-label', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Acme Texting",
    "primary_color": "#1a73e8"
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/v1/white-label",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "name": "Acme Texting",
        "primary_color": "#1a73e8"
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "name": "Acme Texting",
    "logo_url": "https://example.com/logo.png",
    "primary_color": "#1a73e8",
    "support_email": "help@acme.example.com",
    "domain": "app.acme.example.com",
    "domain_status": "active",
    "white_label_enabled": true
  }
}

#Upload your logo

Stores a PNG, JPG, WebP or GIF logo and returns its public url. Send that url as logo_url in Set your brand. Needs the Registration permission (manage_brands) and a white label brand, which signing the agreement makes.

Parameters

filefile, multipartRequired: The image, sent as multipart/form-data.

Errors

HTTP	Code	When
400	`UNSUPPORTED_LOGO_TYPE`	The file is not a PNG, JPG, WebP or GIF.
403	`logo_needs_brand`	Sign the white label agreement first.
413	`FILE_TOO_LARGE`	The file is over the upload limit.

curl -X POST "https://api.tryready.com/v1/media/brand-logo" \
  -H "X-API-Key: $READY_API_KEY" \
  -F "file=@logo.png"

Returns:

{
  "success": true,
  "url": "https://api.tryready.com/media/3f9c2a7e.png",
  "content_type": "image/png",
  "size": 18402
}

#Set your custom domain

Saves the domain your sub-accounts use to sign in, and returns the DNS records to add. It goes live once Ready can see the records. If you already have a live domain, it stops working as soon as you save a new one, so add the new DNS records before you save. Needs the Manage team permission (invite_team), and the first month of white label paid.

Parameters

domainstring · required: The domain, for example app.acme.example.com.

Errors

HTTP	Code	When
403	`not_agency_owner`	The key is not for the white label account itself or an admin seat of it, or it acts as a sub-account.
403	`needs_team_access`	The key’s seat does not have the Manage team permission.
400	`invalid_field`	The domain is not valid.
402	`fee_unpaid`	The first month of white label isn’t paid yet. Pay it in white label setup on the Partner page, then send this again.
404	`no_brand`	This account has not joined white label yet.
409	`domain_taken`	Another account already uses that domain.
502	`domain_setup_failed`	We couldn’t reach the domain service. Nothing was saved; try again in a few minutes.
503	`domains_unavailable`	Custom domains are not available on this server yet. Nothing was saved. Contact Ready support to connect your domain.

curl -X POST "https://api.tryready.com/v1/white-label/domain" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "app.acme.example.com"
  }'

const res = await fetch('https://api.tryready.com/v1/white-label/domain', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "domain": "app.acme.example.com"
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.post(
    "https://api.tryready.com/v1/white-label/domain",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "domain": "app.acme.example.com"
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "domain": "app.acme.example.com",
    "domain_status": "pending",
    "dns_records": [
      {
        "type": "CNAME",
        "name": "app.acme.example.com",
        "value": "cname.example.net"
      }
    ]
  }
}

#Check your domain again

Checks now whether your DNS records are in place, instead of waiting for the next automatic check. waiting says what is still missing. Needs the Manage team permission (invite_team).

Errors

HTTP	Code	When
403	`not_agency_owner`	The key is not for the white label account itself or an admin seat of it, or it acts as a sub-account.
403	`needs_team_access`	The key’s seat does not have the Manage team permission.
402	`fee_unpaid`	The first month of white label isn’t paid yet. Pay it in white label setup on the Partner page, then send this again.
404	`no_brand`	This account has not joined white label yet.
502	`domain_setup_failed`	We couldn’t reach the domain service. Try again in a few minutes.
503	`domains_unavailable`	Custom domains are not available on this server yet. Contact Ready support to connect your domain.

curl -X POST "https://api.tryready.com/v1/white-label/domain/check" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/white-label/domain/check', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.post(
    "https://api.tryready.com/v1/white-label/domain/check",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "domain": "app.acme.example.com",
    "domain_status": "pending",
    "dns_records": [],
    "waiting": "We can't see the CNAME record yet. Check it's added exactly as shown. New records can take a few hours to show up."
  }
}

#Get your join link

The private sign-up link for your sub-accounts, the daily sign-up limit, and the sign-ups waiting for your answer. url is null when the link is off.

Errors

HTTP	Code	When
403	`not_agency_owner`	The key is not for the white label account itself or an admin seat of it, or it acts as a sub-account.

curl "https://api.tryready.com/v1/white-label/join-link" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/white-label/join-link', {
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/v1/white-label/join-link",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "url": "https://app.acme.example.com/signup?client=TOKEN",
    "daily_cap": 20,
    "waiting": []
  }
}

#Make a new join link

Makes a new join link. The old link stops working. Needs the Manage team permission (invite_team).

Errors

HTTP	Code	When
403	`not_agency_owner`	The key is not for the white label account itself or an admin seat of it, or it acts as a sub-account.
403	`needs_team_access`	The key’s seat does not have the Manage team permission.

curl -X POST "https://api.tryready.com/v1/white-label/join-link" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/white-label/join-link', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.post(
    "https://api.tryready.com/v1/white-label/join-link",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "url": "https://app.acme.example.com/signup?client=TOKEN",
    "daily_cap": 20
  }
}

#Turn off the join link

Turns the join link off. Accounts that already signed up stay. Needs the Manage team permission (invite_team).

Errors

HTTP	Code	When
403	`not_agency_owner`	The key is not for the white label account itself or an admin seat of it, or it acts as a sub-account.
403	`needs_team_access`	The key’s seat does not have the Manage team permission.

curl -X DELETE "https://api.tryready.com/v1/white-label/join-link" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/white-label/join-link', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.delete(
    "https://api.tryready.com/v1/white-label/join-link",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "url": null
  }
}