Skip to main content
PATCH
PublicApiUpdateDirectEmail
Use this endpoint through the Developer API or the matching firstsales CLI command when available. Responses use the stable FirstSales public error envelope.

Authorizations

Authorization
string
header
required

FirstSales developer API key bearer token (fs-key-*).

Headers

Idempotency-Key
string
Required string length: 8 - 200

Path Parameters

orgId
string
required
Minimum string length: 1
wsId
string
required
Minimum string length: 1
contactId
string
required
Pattern: ^[a-f0-9]{24}$
emailId
string
required
Pattern: ^[a-f0-9]{24}$

Body

application/json
subject
string
Required string length: 1 - 300
body
string
Required string length: 1 - 50000
bodyFormat
enum<string>
Available options:
html,
text
cc
string<email>[]
Maximum array length: 10
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
bcc
string<email>[]
Maximum array length: 5
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
scheduledAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

Successful response

email
object
required