Skip to content
Toriidocs

Deep-merge metadata into a pending invitation

PATCH
/api/server/v1/invitations/{invitationId}
curl --request PATCH \
  --url https://api.toriiauth.eu/api/server/v1/invitations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "publicMetadata": { "tenantId": "acme" }, "privateMetadata": { "internalRef": "CRM-42" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
invitationId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
publicMetadata

Deep-merged into the invitation’s public metadata. A key set to null is removed.

object
key
additional properties
any
Example
{
  "tenantId": "acme"
}
privateMetadata

Deep-merged into the invitation’s private metadata. A key set to null is removed.

object
key
additional properties
any
Example
{
  "internalRef": "CRM-42"
}

Responses

Section titled “Responses”

200

Section titled “200”

The updated invitation.

Media typeapplication/json
object
id
required
string format: uuid
environmentId
required
string format: uuid
email
required
string
status
required
string
Allowed values: PENDING ACCEPTED REVOKED EXPIRED
expiresAt
required
string format: date-time
createdAt
required
string format: date-time
acceptedAt
string | null format: date-time
revokedAt
string | null format: date-time
publicMetadata
required
object
key
additional properties
any
privateMetadata
required
object
key
additional properties
any
Example
{
  "status": "PENDING"
}

400

Section titled “400”

Merged metadata over the 8KB budget, or a body naming neither bag.

Media typeapplication/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid secret key.

Media typeapplication/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

404

Section titled “404”

No such invitation in this environment.

Media typeapplication/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

409

Section titled “409”

The invitation is accepted, revoked or expired (invitation_not_pending, with the state on invitationStatus), or its state could not be resolved consistently (invitation_patch_conflict, a server-side fault — do not retry in a loop).

Media typeapplication/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}