Create a signature

POST

/mail/signatures

curl --request POST \
  --url https://mail.work.optidata.cloud/api/mail/signatures \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'signature={ "content": "example", "name": "example" }' \
  --form 'attachments=[ { "file": "binary", "url": "example", "disposition": "inline", "type": "example" } ]'

• Optiwork Mail API

Create a signature for the authenticated user. Send it as multipart/form-data when it embeds images: each entry of attachments carries the file plus the placeholder url used inside signature.content, which is rewritten to the stored image.

Authorizations

• bearerAuth

Request Body^required

object

signature

required

object

content

required

HTML content of the signature.

string

name

string | null

attachments

Images embedded in the signature, at up to 10 MB each.

Array<object> | null

object

file

required

string format: binary

url

required

The placeholder URL used inside signature.content.

string

disposition

required

string

type

required

string

object

signature

required

object

content

required

HTML content of the signature.

string

name

string | null

attachments

Images embedded in the signature, at up to 10 MB each.

Array<object> | null

object

file

required

string format: binary

url

required

The placeholder URL used inside signature.content.

string

disposition

required

string

type

required

string

Examples

Exampleplain

{
  "signature": {
    "name": "Work",
    "content": "<div>Jane Doe — Acme</div>"
  }
}

Responses

200

The created signature.

Media typeapplication/json

A signature block appended to outgoing mail.

object

id

integer

user_id

integer

hash

Stable identifier, used to address the signature.

string

name

string | null

content

HTML content.

string

created_at

string

updated_at

string

Example

{
  "hash": "39922fe6-7060-4932-bc32-eaf484adfd7a"
}

401

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

The request tried to read or write the signatures of another user, which only an administrator may do.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object

message

required

Human-readable description of the failure.

string

Examples

Exampledenied

{
  "message": "Only administrators can manage signatures for other users."
}

422

The request body or query string failed validation.

Media typeapplication/json

object

message

required

The first validation message.

string

errors

required

Validation messages keyed by field name.

object

key

additional properties

Array<string>

Examples

Exampleinvalid

{
  "message": "The conversations field is required.",
  "errors": {
    "conversation_ids": [
      "The conversations field is required."
    ]
  }
}

429

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object

message

required

Human-readable description of the failure.

string

Examples

Examplethrottled

{
  "message": "Too Many Attempts."
}