RedRover Logo

Agency Partners

Add a Client

Adds a client workspace under your agency, optionally with the client's own login.

POST/clients
Scope: clients:write

Needs a partner key; any other key or a connected AI app gets 403.

contact is who you deal with at the client, kept for your records. Storing it sends no invite.

With contactEmail, that person gets a client login to this workspace only: they can use it but never see billing or your other clients. No email is sent; you tell them how to sign in. It also becomes the contact's email when contact.email is not given.

Your listeners get client.created. A sandbox key records a sandbox client instead, and nothing is created.

Headers

  • AuthorizationstringRequired

    Bearer followed by an rr_live_ API key or a connected app's access token. See Authentication.

Body

  • namestringRequired

    The client's name, up to 200 characters

    1 to 200 characters

  • referencestring

    Your own ID for the client. Unique within your agency

    1 to 200 characters

  • contactEmailstring

    Adds this person as the client's own login

    up to 320 characters

  • contactobject

    Your contact at the client: name and email, both optional. No invite is sent

    Show 2 Child Fields
    • namestring

      up to 120 characters · nullable

    • emailany or string or string

Response

201 The new client.

  • dataobjectRequired
    Show 7 Child Fields
    • idstringRequired

      The client's workspace ID (UUID)

    • namestringRequired

      The client's name

    • referencestringRequired

      Your own ID for the client, like a CRM record

      nullable

    • contactobjectRequired

      Who you deal with at the client, for your records. Storing a contact sends no invite

      Show 2 Child Fields
      • namestringRequired

        Your contact's name

        nullable

      • emailstringRequired

        Your contact's email

        nullable

    • sandboxbooleanRequired

      True for clients made with a sandbox key

    • createdAtstringRequired

      ISO 8601 datetime

    • invitedContactEmailstringRequired

      The client login added with the client, when you sent one

      nullable

Errors

Every error uses the error envelope.

  • 400name is missing or a field is invalid
  • 409Another client already uses this name or reference
  • 401The Authorization header is missing, or the key is invalid or revoked
  • 403The key lacks the endpoint's scope, or cannot reach the workspace
  • 429More than 120 requests in a minute. Wait for Retry-After seconds
  • 500Something went wrong on our side
curl -X POST "https://app.tryredrover.com/api/public/v1/clients" \
  -H "Authorization: Bearer $REDROVER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme Analytics",
  "reference": "crm-1042",
  "contact": {
    "name": "Jane Smith",
    "email": "jane@acme.com"
  }
}'
201 Response
{
  "data": {
    "id": "8f14e45f-ceea-4e1a-9c2b-6d7a1c3b9e21",
    "name": "Acme Analytics",
    "reference": "crm-1042",
    "contact": {
      "name": "Jane Smith",
      "email": "jane@acme.com"
    },
    "sandbox": false,
    "createdAt": "2026-11-16T10:00:00Z",
    "invitedContactEmail": null
  }
}