Program Executions

Campaign execution lifecycle

List active executions

get

List all active executions (running, scheduled, paused) for the organization.

Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Responses
chevron-right
200

List of active executions

application/json
get
/program-executions

Get execution

get
Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters
idstring · uuidRequired
Responses
chevron-right
200

Execution details

application/json
get
/program-executions/{id}

Cancel execution

delete

Cancel an execution. Remaining pending contacts are marked as skipped.

Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters
idstring · uuidRequired
Responses
delete
/program-executions/{id}

No content

Pause execution

patch

Pause a running execution. Already-queued calls continue to completion.

Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters
idstring · uuidRequired
Responses
chevron-right
200

Execution paused

application/json
patch
/program-executions/{id}/pause

Resume execution

patch

Resume a paused execution.

Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters
idstring · uuidRequired
Responses
chevron-right
200

Execution resumed

application/json
patch
/program-executions/{id}/resume

Last updated