Create OAuth Client

Create a new OAuth client for a partner or subpartner. This endpoint allows partners to generate OAuth credentials for API authentication.

Request
Security:
bearerAuth
path Parameters
entityType
required
string (OAuth Entity Type)

The type of entity (partner, subpartner, or partnercontact)

Enum: "partner" "subpartner" "partnercontact"
Example: partner
entityId
required
string (OAuth Entity ID) non-empty

The unique identifier of the entity

Example: entity789
Request Body schema: application/json

Request body for creating a new OAuth client

clientName
string (OAuth Client Name) [ 1 .. 255 ] characters

Optional human-readable name for the OAuth client to help identify its purpose or integration

Responses
201

OAuth client created successfully

400

Bad request error

401

Unauthorized error

403

Forbidden error

409

Client mapping already exists

429

Rate limit exceeded - max clients per partner or user reached

500

Internal server error

post/oauth/clients/{entityType}/{entityId}
Request samples
application/json
{
  • "clientName": "My Integration Client"
}
Response samples
application/json
{
  • "data": {
    },
  • "requestId": "06327cae-e075-42ca-b620-c5cfdd3b4e37"
}