Skip to content
ReplycoReplycoAPI

Signatures

A signature is the text an agent’s replies end with: a name, a role, a link to your help centre. Signatures belong to a user, and every signature operation works on the signatures of the user your access token was issued for; you cannot read or change another user’s. To manage the signature of a particular agent, sign in as that agent.

Fields that matter

Section titled “Fields that matter”
Field Meaning
id The signature’s id.
text The signature, as plain text or HTML. Replyco removes unsafe HTML, such as scripts, when it saves it.

Creating and changing a signature

Section titled “Creating and changing a signature”

POST /openapi/signature creates a signature for you and returns it with its id. The new signature applies to every integration your company has connected at that moment. Each call creates another signature, so keep the id and change that signature rather than creating a new one.

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

PUT /openapi/signature/{id} replaces the text and leaves the integrations it applies to unchanged. An id that is not one of your signatures returns 404, for reading and for changing alike.

Terminal window
curl -X PUT "https://open-api.replyco.com/openapi/signature/1d3f5b7d-9e1a-4c3e-8a5c-7e9a1c3e5a7b" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text": "<p>Alex Morgan<br>Customer care team lead, Example Outdoor Ltd</p>"}'

Listing

Section titled “Listing”

GET /openapi/signature returns all your signatures, each with its id and text. It takes no parameters and is not paged.

Operations

Section titled “Operations”
Method Path Summary Scopes
GET /openapi/signature List my signatures —
POST /openapi/signature Create a signature —
GET /openapi/signature/{id} Get one of my signatures —
PUT /openapi/signature/{id} Update a signature —

Errors

Section titled “Errors”
Status Meaning Returned by
400 The request is invalid (e.g. text is missing). POST /openapi/signature, PUT /openapi/signature/{id}
401 User is not authenticated or authorized. GET /openapi/signature, POST /openapi/signature, GET /openapi/signature/{id}, PUT /openapi/signature/{id}
404 No such signature belongs to the current user. GET /openapi/signature/{id}, PUT /openapi/signature/{id}
Section titled “Related”