GOgovernment-digital-service
Invites

Creates an invitation to allow a new team member to join an existing service.

Changed on
post/v1/api/invites/create-invite-to-join-service

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

emailstring email required
role_name'admin' | 'view-and-refund' | 'view-only' | 'view-and-initiate-moto' | 'view-refund-and-initiate-moto' | 'super-admin' required
senderstring required

User external ID

service_external_idstring required

Example request

{
  "email": "example@example.gov.uk",
  "role_name": "view-only",
  "sender": "d0wksn12nklsdf1nd02nd9n2ndk",
  "service_external_id": "dj2jkejke32jfhh3"
}

Response

Created

attempt_counterinteger
disabledboolean
emailstring
expiredboolean
inviteLinkstring
is_invite_to_join_serviceboolean
otp_keystring
password_setboolean
rolestring
telephone_numberstring
user_existboolean

Example response

{
  "_links": [
    {
      "href": "https://an.example.link",
      "method": "GET",
      "rel": "self"
    }
  ],
  "email": "example@example.gov.uk",
  "is_invite_to_join_service": true,
  "otp_key": "ABC123",
  "role": "view-only",
  "telephone_number": "+440787654534"
}

Changes

  • 61835ad90a33Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

  • 61821d66cdcbRevision changes
    • info

      the request property's minLength was decreased from 1 to 0

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      the request property's minLength was decreased from 1 to 0