DotsDocs
Team

Cancel an Organization Developer Invite

Cancel a pending invite. Canceling an already canceled invite returns it unchanged.

DELETE
/v2/organizations/developer-invites/{invite_id}

Cancel a pending invite. Canceling an already canceled invite returns it unchanged.

Authorization

api_key
headerAuthorizationBasic <token>

Path Parameters

invite_id*string

ID of the invite.

Formatuuid

Response Body

OK

application/json
  1. response
id?string
Formatuuid
email?string
Formatemail
status?string

created means the invite is pending.

Value in"created""accepted""expired""canceled"
created?string
Formatdate-time
expiry?string
Formatdate-time
link?string

Link the invitee opens to accept. It only works for the invited email address.

Formaturi
role?|

custom when the invite grants a custom role, otherwise a built-in role.

custom_role_id?|
Formatuuid
Example Request
curl -X DELETE 'https://api.dots.dev/api/v2/organizations/developer-invites/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "email": "user@example.com",  "status": "created",  "created": "2019-08-24T14:15:22Z",  "expiry": "2019-08-24T14:15:22Z",  "link": "http://example.com",  "role": "payer",  "custom_role_id": "4f5deddb-3218-41fa-acf0-ef42cdc17a8c"}