Invites

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

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

Request body

emailstring email 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

Changed in 10 of the 53 revisions of this API.8214

Jan 20, 202661835ad90a333See the full diff
- ▲
  the request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the request property's minLength was increased from 0 to 1
  request-property-min-length-increased
Nov 25, 202561821d66cdcb3See the full diff
- ○
  the request property's minLength was decreased from 1 to 0
  request-property-min-length-decreased
- ○
  the request property's minLength was decreased from 1 to 0
  request-property-min-length-decreased
- ○
  the request property's minLength was decreased from 1 to 0
  request-property-min-length-decreased
Nov 24, 202561835ad90a332See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
May 20, 20250a185c6297891See the full diff
- ▲
  the request property format changed from no format to email
  request-property-type-changed
Apr 10, 2025e1deccce0b143See the full diff
- ▲
  the request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the request property's minLength was increased from 0 to 1
  request-property-min-length-increased
Sep 12, 20243f6a3bbb921916See the full diff
- ▲
  request property was restricted to a list of enum values
  request-property-became-enum
- ○
  added the new admin enum value to the request property
  request-property-enum-value-added
- ○
  added the new super-admin enum value to the request property
  request-property-enum-value-added
- ○
  added the new view-and-initiate-moto enum value to the request property
  request-property-enum-value-added
- ○
  added the new view-and-refund enum value to the request property
  request-property-enum-value-added
- ○
  added the new view-only enum value to the request property
  request-property-enum-value-added
- ○
  added the new view-refund-and-initiate-moto enum value to the request property
  request-property-enum-value-added
Dec 19, 20226a7bd1eb62a71See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
Dec 15, 20225163f2c9ccc311See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
Dec 13, 2022566e66065caa1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Dec 12, 2022df693274547d1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history