Developers
V1PlatformMerchantsIdInvitations

Create or replace a seven-day, email-bound owner invitation; does not send messages

Returns a secret once. Replacement revokes all older unused owner links. The recipient must verify the invited email and use a fresh password or email-code session. Business phone is contact-only. Accepting activates the workspace atomically; historical phone-bound invitations require reissue.

POST
/v1/platform/merchants/{id}/invitations

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/platform/merchants/497f6eca-6276-4993-bfeb-53cbbbba6f08/invitations" \  -H "Content-Type: application/json" \  -d '{    "expectedVersion": 1  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "token": "string",  "expiresAt": "2019-08-24T14:15:22Z"}

Replace the owner invitation and email its new seven-day link POST

Send and resend both invalidate every previous unused owner link. Provider acceptance confirms neither inbox delivery nor membership. Recipient must verify the invited email and use a fresh password or email-code session.

Revoke an unaccepted merchant-owner invitation DELETE

Next Page