Cowdidocs
API ReferenceMerchant members

Revoke an invitation

DELETE
/v1/merchants/{id}/invitations/{invitationId}

Cancel the merchant's pending member invitation. Core resolves the merchant's organization before authorization. Requires merchant:members:write on the merchant, from direct or inherited roles. Returns 204 when the invitation does not exist or is no longer pending.

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

id*string

The merchant ID from the sales app.

Formatuuid
invitationId*string

The invitation ID.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/merchants/550e8400-e29b-41d4-a716-446655440001/invitations/550e8400-e29b-41d4-a716-446655440002"
Empty
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "FORBIDDEN",  "description": "Forbidden"}
Empty
{  "code": "RATE_LIMIT_EXCEEDED",  "description": "Too Many Requests"}
{  "code": "INTERNAL_ERROR",  "description": "Internal Server Error"}

Invite a merchant member POST

Invite an email to join the merchant with a role. Core resolves the merchant's organization before authorization. Requires `merchant:members:write` on the merchant, from direct or inherited roles. An existing pending invitation returns 200 and sends no email. A new invitation returns 201 and sends an email built from `accept_url`. The invitee accepts or rejects the invitation through their user invitation routes.

Delete a merchant member DELETE

Remove the user's membership and direct roles from the merchant. Core resolves the merchant's organization before authorization. Requires `merchant:members:write` on the merchant, from direct or inherited roles. Returns 204 when the user has no active membership.