---
title: "Set brand name, connect-link return URLs and the REST policy"
method: PATCH
path: "/account"
tags: ["Partner"]
---

# Set brand name, connect-link return URLs and the REST policy

`PATCH /account`

## Request

- Base URL: `https://app.pumpgtm.com/api/partner/v1`
- URL: `https://app.pumpgtm.com/api/partner/v1/account`
- Auth: HTTP bearer

Two groups, each behind its own capability (GET /account enterprise). Connect settings (enterprise.linkedinConnect): where end users land after a hosted LinkedIn connect link resolves, and the white-label name shown on that page (1-60 characters; null uses your workspace name). An absent field is kept, null or "" clears it. The end user id and link id are appended to the redirect as externalUserId and connectLinkId; only expired or revoked links use the failure URL. REST policy (enterprise.outreach): requireUserHeader true makes every /api/v1 request with this key that lacks X-PumpGTM-User fail with 400 user_header_required, so a missing header can never act on your own workspace; /api/partner/v1 and the per-user MCP URL are unaffected. Nothing is written when any group is refused. 400 { error, field } on a bad value (invalid_url, https_required, host_not_allowed, url_too_long, invalid_brand_name, invalid_require_user_header); 400 nothing_to_update or invalid_body with field null; 403 enterprise_required when the needed capability is off.

## Request body

- object
  - `successRedirectUrl` string, uri, nullable: Absolute https URL to a public host, no credentials or fragment. null or "" clears it; an absent field is left as it is.
  - `failureRedirectUrl` string, uri, nullable: Absolute https URL to a public host, no credentials or fragment. null or "" clears it; an absent field is left as it is.
  - `brandName` string, nullable
  - `requireUserHeader` boolean

## Response `200`

Successful response. Read outcome fields; success does not imply delivery.

- object
  - `linkedinConnect` object, required
    - `successRedirectUrl` string, nullable, required
    - `failureRedirectUrl` string, nullable, required
    - `brandName` string, nullable, required
  - `rest` object, required
    - `requireUserHeader` boolean, required: When true, every /api/v1 request made with this partner key must carry X-PumpGTM-User; without it the request is 400 user_header_required instead of acting on the partner workspace. Default false.

## Other responses

- `400`: Invalid input; for partner keys also user_header_required when the account requires X-PumpGTM-User
- `401`: Missing, invalid or revoked key
- `403`: Workspace mismatch, channel or feature disabled; for partner keys also enterprise_required and user_disabled
- `404`: Resource unavailable in this workspace
- `409`: Revision, identity or state conflict: { error, message } and nothing changed
- `429`: Rate limit; respect Retry-After when provided
- `500`: internal_error: an unexpected failure on our side; retry, then contact PumpGTM
- `503`: Dependency unavailable; identity may be unknown

## Changes

- **2026-10-12** `06d2e4d0e84b`: 8 info
  - the response property `error` became required for the status `400`
  - the response property `error` became required for the status `401`
  - the response property `error` became required for the status `403`
  - the response property `error` became required for the status `404`
  - …4 more
- **2026-10-12** `08c80059d483`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pumpgtm/apis/pumpgtm-api/changes/account/patch.md)

---

[API](https://skmtc.dev/pumpgtm/apis/pumpgtm-api.md) - [All operations](https://skmtc.dev/pumpgtm/apis/pumpgtm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pumpgtm/apis/pumpgtm-api/revisions/06d2e4d0e84b?raw)