Sign in
Invites

Update an invite

patch/v1/api/invites/{code}

Path parameters

codestring required

Request body

string required

Response

OK

attempt_counterinteger
disabledboolean
emailstring
expiredboolean
inviteLinkstring
password_setboolean
rolestring
telephone_numberstring
typestring
user_existboolean

Example response

{
  "_links": [
    {
      "href": "https://an.example.link",
      "method": "GET",
      "rel": "self"
    }
  ],
  "email": "example@example.gov.uk",
  "role": "view-only",
  "type": "service"
}

Changes