Invite a customer user
POST/v1/customer/:customerId/invites
Asks for the supplied address to be given access to the customer. If the customer has no users yet, the invitation is emailed straight to that address. If it already has one, the invitation is held and an approval request goes to the customer's longest-standing user instead; the invited address hears nothing until they approve. Accepted asynchronously either way; the outcome in the response says which path it took, and does not confirm delivery.
Request
Responses
- 202
- 400
- 401
- 403
- 404
- 409
Invite initiated. "sent" means the invitation was emailed to the address, "approval_requested" means an existing user of the customer must admit the address first and it has heard nothing yet.
Request body is missing or fails validation
Missing or invalid API key or session
The caller's user type, scope or client binding does not permit this operation
No such customer for this client
The address already has an account; or the customer has no users yet and an invitation to a different address is already outstanding — only one may be outstanding while the customer has nobody who can approve; or this client already holds an invitation the customer accepted, which only an expired or rejected one may replace. The message in the response says which.