Skip to main content
POST
Invite test customer
Creates a synthetic Connect customer, visible only to your organization, and one PENDING invitation for every agent you name. You provide agents only; no customer email, phone, or identity details. Use the returned customer Party ID and invitation IDs to accept or decline each invitation. The customer grants no agent access and holds no funds until an invitation is accepted. See Simulate Connect.

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

Idempotency-Key
string
required

Unique key for safely retrying a request without creating duplicates.

Maximum string length: 255
X-Agent-ID
string | null

Deprecated: agent identity comes from the credential. Sending this header with a party API key or user credential returns 403 agent_credential_required.

Maximum string length: 36
Pattern: ^agt_[0-9a-f]{32}$
X-Instance-ID
string | null

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Maximum string length: 1024

Body

application/json
data
InviteSandboxCustomerData · object
required

Response

Successful Response

data
AgentDelegationInvitationResource · object[]
required

Pending invitations created, one for each agent listed.

Required array length: 1 - 50 elements
meta
object
required