Create Invitation

POST

/api/Invitations

curl --request POST \
  --url https://example.com/api/Invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "firstName": "example", "lastName": "example", "email": "hello@example.com", "phone": "example", "expiresInDays": 1 }'

Mints a new self-serve onboarding link. The plaintext token is returned exactly once — store it (or the resulting URL) before navigating away; only its SHA-256 hash is persisted. At least one of email or phone must be supplied so there’s a channel to deliver the link through.

Authorizations

• Bearer

Request Body

object

merchantId

required

string format: uuid

firstName

required

string

>= 1 characters <= 100 characters

lastName

required

string

>= 1 characters <= 100 characters

email

string format: email

nullable <= 256 characters

phone

string

nullable <= 50 characters

expiresInDays

integer format: int32

nullable >= 1 <= 90

Example ^generated

{
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "firstName": "example",
  "lastName": "example",
  "email": "hello@example.com",
  "phone": "example",
  "expiresInDays": 1
}

object

merchantId

required

string format: uuid

firstName

required

string

>= 1 characters <= 100 characters

lastName

required

string

>= 1 characters <= 100 characters

email

string format: email

nullable <= 256 characters

phone

string

nullable <= 50 characters

expiresInDays

integer format: int32

nullable >= 1 <= 90

Example ^generated

{
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "firstName": "example",
  "lastName": "example",
  "email": "hello@example.com",
  "phone": "example",
  "expiresInDays": 1
}

object

merchantId

required

string format: uuid

firstName

required

string

>= 1 characters <= 100 characters

lastName

required

string

>= 1 characters <= 100 characters

email

string format: email

nullable <= 256 characters

phone

string

nullable <= 50 characters

expiresInDays

integer format: int32

nullable >= 1 <= 90

Example ^generated

{
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "firstName": "example",
  "lastName": "example",
  "email": "hello@example.com",
  "phone": "example",
  "expiresInDays": 1
}

Responses

201

Invitation created.

Media type application/json

object

outcome

string

Allowed values: Ok MerchantNotFound NoDeliveryChannel

invitationId

string format: uuid

nullable

token

string

nullable

expiresAt

string format: date-time

nullable

email

string

nullable

phone

string

nullable

Example

{
  "outcome": "Ok"
}

400

Neither email nor phone was supplied, or validation failed.

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Merchant not found.

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}