tx-agent-kit
API Reference

emailCampaigns Endpoints

API endpoints for the emailCampaigns resource group

emailCampaigns Endpoints

GET /v1/admin/email-campaigns

Parameters

NameInTypeRequiredDescription
statusquerystringNo---
campaignTypequerystringNo---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/admin/email-campaigns

Responses

StatusDescription
201Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/admin/email-campaigns/{campaignId}

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

PATCH /v1/admin/email-campaigns/{campaignId}

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/admin/email-campaigns/{campaignId}/activate

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/admin/email-campaigns/{campaignId}/pause

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/admin/email-campaigns/{campaignId}/resume

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/admin/email-campaigns/{campaignId}/archive

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/admin/email-campaigns/{campaignId}/steps

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/admin/email-campaigns/{campaignId}/steps

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
201Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

PATCH /v1/admin/email-campaigns/{campaignId}/steps/{stepId}

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---
stepIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

DELETE /v1/admin/email-campaigns/{campaignId}/steps/{stepId}

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---
stepIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/admin/email-campaigns/{campaignId}/enrollments

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/admin/email-campaigns/{campaignId}/enroll

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/admin/email-campaigns/{campaignId}/enrollments/{enrollmentId}/cancel

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---
enrollmentIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/admin/email-campaigns/{campaignId}/analytics

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/admin/email-campaigns/{campaignId}/steps/{stepId}/analytics

Parameters

NameInTypeRequiredDescription
campaignIdpathstringYes---
stepIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

storagemetering Endpoints

API endpoints for the storagemetering resource group

emailWebhooks Endpoints

API endpoints for the emailWebhooks resource group

On this page

emailCampaigns EndpointsGET /v1/admin/email-campaignsParametersResponsesPOST /v1/admin/email-campaignsResponsesGET /v1/admin/email-campaigns/{campaignId}ParametersResponsesPATCH /v1/admin/email-campaigns/{campaignId}ParametersResponsesPOST /v1/admin/email-campaigns/{campaignId}/activateParametersResponsesPOST /v1/admin/email-campaigns/{campaignId}/pauseParametersResponsesPOST /v1/admin/email-campaigns/{campaignId}/resumeParametersResponsesPOST /v1/admin/email-campaigns/{campaignId}/archiveParametersResponsesGET /v1/admin/email-campaigns/{campaignId}/stepsParametersResponsesPOST /v1/admin/email-campaigns/{campaignId}/stepsParametersResponsesPATCH /v1/admin/email-campaigns/{campaignId}/steps/{stepId}ParametersResponsesDELETE /v1/admin/email-campaigns/{campaignId}/steps/{stepId}ParametersResponsesGET /v1/admin/email-campaigns/{campaignId}/enrollmentsParametersResponsesPOST /v1/admin/email-campaigns/{campaignId}/enrollParametersResponsesPOST /v1/admin/email-campaigns/{campaignId}/enrollments/{enrollmentId}/cancelParametersResponsesGET /v1/admin/email-campaigns/{campaignId}/analyticsParametersResponsesGET /v1/admin/email-campaigns/{campaignId}/steps/{stepId}/analyticsParametersResponses