PUpumpgtm
Partner

Create an end user's workspace

Changed on

Creates the isolated workspace for one end user before any MCP or REST traffic. Idempotent: 201 when created, 200 unchanged when the user already existed (monthlyLeadCap is then not applied; use PATCH). The response carries the user's mcpUrl (https://mcp.pumpgtm.com/mcp/u/{externalUserId}) and, once outreach is enabled on the partner account, rest: { header: "X-PumpGTM-User", value } and outreach: "enabled"; until then rest is null and outreach is "disabled". 400 invalid_external_user_id, 400 invalid_monthly_lead_cap.

post/users

Request

  • Base URL
    https://app.pumpgtm.com/api/partner/v1
  • Auth
    HTTP bearer

Request body

externalUserIdstring required

Your own id for the end user: letters, digits and _ . : @ -, up to 120 characters.

namestring
monthlyLeadCapinteger nullable

People search cap for this user per period; null means no cap.

Response

The user already existed; returned unchanged.

externalUserIdstring required

Your own id for the end user: letters, digits and _ . : @ -, up to 120 characters.

namestring nullable required
createdAtstring required
status'active' | 'disabled' required
monthlyLeadCapinteger nullable required

People search cap for this user per period; null means no cap.

mcpUrlstring required

https://mcp.pumpgtm.com/mcp/u/{externalUserId}

outreach'enabled' | 'disabled' required

disabled until PumpGTM enables outreach on the partner account.

Changes

  • 06d2e4d0e84bRevision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • 08c80059d483Revision changes
    • info

      endpoint added