Skip to main content
PATCH
/
v3
/
orgs
/
{org_id}
/
organisation-bridge-requests
/
{bridge_request_id}
Update an existing organisation bridge request
curl --request PATCH \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/organisation-bridge-requests/{bridge_request_id} \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "type": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {
      "required": "<unknown>",
      "status": "accepted"
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "code": "<string>",
      "notes": "<string>",
      "status": "initiated"
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "initiating_organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "initiating_author": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "recipient_organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "recipient_user": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "organisation_bridge": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

bridge_request_id
string<uuid>
required

The unique identifier for the organisation bridge request.

Body

application/vnd.api+json

The organisation bridge request to create.

data
object
required

Response

Get an organisation bridge request.

JSON API response object

data
object
required

An organisation bridge request

jsonapi
object
required