Partner accounts only. Ask Blujay support to make your workspace a partner and issue your partner keys.
Your first customer in three calls
1. Create the customer
curl
201 Created
data.id. It’s the customer ID you send in the Blujay-Workspace header from now on.
2. Give it a number
curl
phone_number_id and display_number. It’s ready to send right away. See Phone numbers.
3. Send as the customer
The same request any Blujay customer makes, plus the header.202 Accepted, the same as Send messages. Then subscribe to webhooks once to get every customer’s replies and delivery updates.
The Blujay-Workspace header
With the header, a request runs as that customer, exactly as if it had its own key. Every page in these docs works this way: contacts, chats, attachments, phone numbers. Without the header, a partner key reaches only your partner calls (/v1/partner/...) and /v1/me.
Key roles
Give your app servers a
messaging key and keep the admin key for setup.
Rate limits
Each customer gets the normal rate limits. All your customers together get ten times one customer’s limits. A429 says which you hit in error.details[0].scope: partner_customer (one customer) or partner (your total).
Good to know
- One key, not one per customer. A new customer works the moment you create it; there’s no key to issue or store.
- A customer that isn’t yours returns
404. So does a malformed ID. Check the header first when you get one. - Paused or closing customers are read-only. Blujay pauses or closes a customer when you ask. Changes then return
409 CUSTOMER_PAUSEDorCUSTOMER_CLOSING. - Your customers never sign in to Blujay. No emails or invites go to them or their teammates.
- Numbers are billed to you, not to your customers.
Partner guides
Customers and teammates
Create and list customers, and add the people who text.
Phone numbers
Give a customer a dedicated number, and release it.
Partner webhooks
One endpoint for every customer’s events.
Embedded view
Show a customer’s texts inside your product.