Change one of the workspace's letters (ADMIN+, dashboard user)

PATCH

/recovery-templates/{templateId}

curl --request PATCH \
  --url https://api.invogi.com/v1/recovery-templates/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "purpose": "CLAIM", "subject": "example", "body": "example" }'

Built-in letters cannot be changed (403).

Authorizations

• bearerAuth

Parameters

Path Parameters

templateId

required

string

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 100 characters

purpose

string

Allowed values: CLAIM FOLLOW_UP FINAL_REMINDER STATEMENT_REQUEST

subject

string

>= 1 characters <= 300 characters

body

string

>= 10 characters <= 10000 characters

Responses

200

The template

Media typeapplication/json

object

id

required

Builtin: for a built-in, otherwise a uuid

string

name

required

string

purpose

required

string

Allowed values: CLAIM FOLLOW_UP FINAL_REMINDER STATEMENT_REQUEST

subject

required

string

body

required

string

builtIn

required

boolean

description

string | null

updatedAt

string | null format: date-time

Example

{
  "purpose": "CLAIM"
}

400

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

403

API key lacks required scope/role

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

404

Resource not found

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

409

Conflicting idempotency key or resource processing state

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}