Invite Buyer
POST/api/admin/portal/accounts/:customer/buyers/invite
Grant a contact on this customer a portal login and email them the single-use invite. Enrols the customer as a portal account if it is not one already.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Portal access belongs to a contact, so the customer keeps one list of people. Send either contact_id (an existing contact on this customer) or name + email (adds them to the customer's contacts as part of the invite) — one or the other is required.
Rejected with 422 when the contact belongs to another customer, has no email address to send to, or already has portal access.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.