RedRover Logo

Agency Partners

Update a Client

Renames a client or changes your reference or contact for it.

PATCH/clients/{client}
Scope: clients:write

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

Your listeners get client.updated, with the previous name, reference and contact.

Headers

  • AuthorizationstringRequired

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

Path Parameters

  • clientstringRequired

    The client's workspace ID, or your own reference for it. A UUID is tried as an ID first

Body

  • namestring

    The new name

    1 to 200 characters

  • referencestring

    The new reference. null clears it

    1 to 200 characters · nullable

  • contactobject

    The contact's name and email. A field left out stays; null clears it

    Show 2 Child Fields
    • namestring

      up to 120 characters · nullable

    • emailany or string or string

Response

200 The client after the change.

  • dataobjectRequired
    Show 6 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

Errors

Every error uses the error envelope.

  • 404No client with this ID or reference in your agency
  • 409Another client already uses this 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 PATCH "https://app.tryredrover.com/api/public/v1/clients/crm-1042" \
  -H "Authorization: Bearer $REDROVER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme Analytics Inc."
}'
200 Response
{
  "data": {
    "id": "8f14e45f-ceea-4e1a-9c2b-6d7a1c3b9e21",
    "name": "Acme Analytics Inc.",
    "reference": "crm-1042",
    "contact": {
      "name": "Jane Smith",
      "email": "jane@acme.com"
    },
    "sandbox": false,
    "createdAt": "2026-11-16T10:00:00Z"
  }
}