Skip to content

Inviting a user to an organization

Entity relationship diagram

erDiagram
  ORGANIZATION ||--o{ INVITATION : contains
  ORGANIZATION ||--|{ MEMBERSHIP : contains
  INVITATION ||..o| USER : references
  MEMBERSHIP ||..|| USER : references

Info

  • Exactly one ORGANIZATION contains zero or more INVITATION
  • Exactly one ORGANIZATION contains one or more MEMBERSHIP
  • Exactly one INVITATION references zero or one USER
  • Exactly one MEMBERSHIP references exactly one USER

Add invitation

POST https://api.zorgapis.nl/v1beta1/organizations/4a7c2c17-6514-46f8-aa05-6a22fb18b4ad/invitations HTTP/1.1
Content-Type: application/json

{
  "emailAddress": "john.doe@nictiz.nl" // (1)!
}
  1. The email address of the user. Each organization can have only one pending invitation per email address, and the email address cannot belong to an existing member.
HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "88411780-1d25-4bc3-86a5-f2f901d9a900", // (1)!
  "emailAddress": "john.doe@nictiz.nl",
  "status": "PENDING" // (2)!
}
  1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the invitation by the API server.
  2. The status of the invitation. For example, "PENDING" or "ACCEPTED".

Note

To learn more, view the API reference or fork our Postman Collection and explore our API.