Skip to main content

Create a customer invite

POST/customers/{customerId}/invites/
v2
POST
customer-create-customer-invite

Request

  • customerIdstring (uuid)
    required

    ID of the Customer to create a CustomerInvite for.

Responses

application/json
  • avatarRefIdstring (uuid)

    Reference to the Project's avatar.

  • customerIdstring (uuid)
    required

    ID of the Customer the invite is for.

  • customerNamestring
    required

    Name of the Customer the user is invited to.

  • idstring (uuid)
    required

    ID of the CustomerInvite.

  • informationobject
    required
    • invitationTokenstring

      Token for authentication purposes.

    • invitedBystring (uuid)
      required

      ID of the user that created the invite.

    • userIdstring (uuid)

      ID of the user this invite is for.

  • mailAddressstring (email)
    required

    Mail-address of the user the invite is for.

  • membershipExpiresAtstring (date-time)

    Time the CustomerMembership should expire at.

  • messagestring

    Message contained in the CustomerInvite.

  • rolestring (one of: notset, owner, member, accountant)
    required

Usage examples

$ curl \
--fail \
--location \
-X POST \
-d '{"mailAddress":"email@mittwald.example","membershipExpiresAt":"2024-12-03T00:30:31.130Z","message":"string","role":"notset"}' \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
-H 'Content-Type: application/json' \
https://api.mittwald.de/v2/customers/f0f86186-0a5a-45b2-aa33-502777496347/invites