Create a signature

POST

/openapi/signature

const url = 'https://open-api.replyco.com/openapi/signature';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: '{ "text": "<p>Alex Morgan<br>Customer care, Example Outdoor Ltd</p>" }'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://open-api.replyco.com/openapi/signature \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{ "text": "<p>Alex Morgan<br>Customer care, Example Outdoor Ltd</p>" }'

Creates a signature for the authenticated user and returns it (including its generated id). The new signature is made available across all of your connected integrations — you do not choose accounts, and you cannot create a signature for another user.

Request

text (required) — the signature content, as plain text or HTML. HTML is sanitized on save: unsafe markup (scripts, event handlers, etc.) is removed and only formatting-safe HTML is stored.

Best practices

Keep signatures short and consistent with your brand.
Use simple, safe HTML (paragraphs, line breaks, links); anything unsafe is stripped automatically.

Authorizations

Bearer

Request Body

The signature to create. text is required.

Input model for creating a signature for the current user. The new signature is made available across all of the user’s connected integrations.

object

text

required

The signature content. Required. Accepts plain text or HTML. HTML is sanitized on save: unsafe markup (scripts, event handlers, etc.) is stripped, so only formatting-safe HTML is stored.

string

>= 1 characters

Example

{
  "text": "<p>Alex Morgan<br>Customer care, Example Outdoor Ltd</p>"
}

Input model for creating a signature for the current user. The new signature is made available across all of the user’s connected integrations.

object

text

required

The signature content. Required. Accepts plain text or HTML. HTML is sanitized on save: unsafe markup (scripts, event handlers, etc.) is stripped, so only formatting-safe HTML is stored.

string

>= 1 characters

Example

<p>Best regards,<br/>Jane — Customer Support</p>

Input model for creating a signature for the current user. The new signature is made available across all of the user’s connected integrations.

object

text

required

The signature content. Required. Accepts plain text or HTML. HTML is sanitized on save: unsafe markup (scripts, event handlers, etc.) is stripped, so only formatting-safe HTML is stored.

string

>= 1 characters

Example

<p>Best regards,<br/>Jane — Customer Support</p>

Input model for creating a signature for the current user. The new signature is made available across all of the user’s connected integrations.

object

text

required

The signature content. Required. Accepts plain text or HTML. HTML is sanitized on save: unsafe markup (scripts, event handlers, etc.) is stripped, so only formatting-safe HTML is stored.

string

>= 1 characters

Example

<p>Best regards,<br/>Jane — Customer Support</p>

Responses

200

The signature was created and is returned.

application/json

A signature belonging to the current user. A signature applies across all of the user’s connected integrations.

object

string format: uuid

text

The signature content. May contain HTML; unsafe markup is stripped on save.

string

nullable

Example

{
  "id": "1d3f5b7d-9e1a-4c3e-8a5c-7e9a1c3e5a7b",
  "text": "<p>Alex Morgan<br>Customer care, Example Outdoor Ltd</p>"
}

400

The request is invalid (e.g. text is missing).

401

User is not authenticated or authorized.