/v1/orgs/{id}/suspend

POST

/v1/orgs/{id}/suspend

curl --request POST \
  --url https://api.reindeer.example.tr/v1/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/suspend \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example" }'

Scope orgs:write, fresh step-up. Suspends a pending or active organisation at once, records the reason in its history and cancels its open activation and resume requests.

Authorizations

• mutualTLS
• session

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

reason

required

string

>= 1 characters <= 500 characters

Example ^generated

{
  "reason": "example"
}

Responses

200

The suspended organisation with its history

Media typeapplication/json

object

id

string

name

string

state

string

Allowed values: pending active suspended

contact_email

string

data_source

string

terms_version

string

founder

string

founder_name

string

source

Staff views only: the network the signup came from, an IPv4 /24 or an IPv6 /48

string

created_at

string format: date-time

activated_at

string format: date-time

suspended_at

string format: date-time

events

Array<object>

object

at

string format: date-time

kind

string

Allowed values: signed_up activated suspended resumed

by

string

approval

string

reason

string

Example

{
  "state": "pending",
  "events": [
    {
      "kind": "signed_up"
    }
  ]
}

409

Org_state when it is already suspended

422

Suspend_reason