Cowdidocs
API ReferenceMerchant members

Invite a merchant member through an organization

Deprecated

POST
/v1/organizations/{organizationId}/merchants/{merchantId}/invitations

Deprecated. Use POST /v1/merchants/{id}/invitations. Requires merchant:members:write on the merchant. The organization must match the caller and the merchant.

Authorization

oauth2
AuthorizationBearer <token>

Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.

In: header

Path Parameters

organizationId*string

The organization slug.

merchantId*string

The merchant ID from the sales app.

Formatuuid

Request Body

application/json

Request to invite an email to join the merchant with a role.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/organizations/greenwheels/merchants/550e8400-e29b-41d4-a716-446655440001/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "jane@example.com",    "role": "merchant-financing-admin",    "accept_url": "https://app.greenwheels.example/invitations/accept"  }'
{  "id": "550e8400-e29b-41d4-a716-446655440002",  "merchant_id": "550e8400-e29b-41d4-a716-446655440001",  "organization_id": "greenwheels",  "email": "jane@example.com",  "role": "merchant-financing-admin",  "status": "PENDING",  "created_at": "2026-03-15T10:00:00Z",  "resource_id": "string"}
{  "id": "550e8400-e29b-41d4-a716-446655440002",  "merchant_id": "550e8400-e29b-41d4-a716-446655440001",  "organization_id": "greenwheels",  "email": "jane@example.com",  "role": "merchant-financing-admin",  "status": "PENDING",  "created_at": "2026-03-15T10:00:00Z",  "resource_id": "string"}
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "FORBIDDEN",  "description": "Forbidden"}
{  "id": "550e8400-e29b-41d4-a716-446655440002",  "merchant_id": "550e8400-e29b-41d4-a716-446655440001",  "organization_id": "greenwheels",  "email": "jane@example.com",  "role": "merchant-financing-admin",  "status": "PENDING",  "created_at": "2026-03-15T10:00:00Z",  "resource_id": "string"}
{  "code": "RATE_LIMIT_EXCEEDED",  "description": "Too Many Requests"}
{  "code": "INTERNAL_ERROR",  "description": "Internal Server Error"}

List pending invitations through an organization GET

Deprecated. Use `GET /v1/merchants/{id}/invitations`. Requires `merchant:members:read` on the merchant. The organization must match the caller and the merchant.

Revoke an invitation through an organization DELETE

Deprecated. Use `DELETE /v1/merchants/{id}/invitations/{invitationId}`. Requires `merchant:members:write` on the merchant. The organization must match the caller and the merchant.