Create a signature

Signatures

Authorization

Bearer

AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_*)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Signature name

Length1 <= length <= 200

content*string

Signature text

Length1 <= length <= 2000

is_default?boolean

Set as the default signature

Defaultfalse

position?string

Where to inject the signature

Default"append"

Value in"append" | "prepend"

workspace_id?string

Workspace ID to scope this signature to

Response Body

`application/json`

curl -X POST "https://api.relayapi.dev/v1/signatures" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "content": "string"  }'

{
  "id": "string",
  "name": "string",
  "content": "string",
  "is_default": true,
  "position": "append",
  "workspace_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}

Found something wrong? Help us improve this page.

Report an issue Edit this page on GitHub

Signatures

Delete a signature DELETE

Create a signature

Authorization

Request Body

Response Body

201application/json

401application/json

`application/json`

`application/json`