Agent Mail
Required scope: agent_mail:write
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
{}Required scope: agent_mail:read
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Response Body
application/json
{}Required scope: agent_mail:read
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Query Parameters
Response Body
application/json
{}Required scope: agent_mail:write
Drafting never requires a connected email address — from_address_id is optional and the campaign stays a draft until one is set. Sending is a separate run-scoped action. For drips pass ordered steps.
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
{}Required scope: agent_mail:read
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Path Parameters
Response Body
application/json
{}Required scope: agent_mail:write
Passing steps REPLACES all drip steps.
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
{}Required scope: agent_mail:run
Broadcast: schedules the send (scheduled_at defaults to now). Drip: starts the sequence. Requires a sender address, an audience, and content on the campaign.
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
{}Required scope: agent_mail:read
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Response Body
application/json
{}Required scope: agent_mail:write
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
{}Required scope: agent_mail:read
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Path Parameters
Response Body
application/json
{}Required scope: agent_mail:write
Authorization
bearerAuth A Space API key, e.g. wks_live_….
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
{}