Program Executions

Campaign execution lifecycle

List active executions

get

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

Authorizations

BearerAuth

AuthorizationstringRequired

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

Responses

200

List of active executions

application/json

401

Unauthorized

get

/program-executions

HTTPcURLJavaScriptPython

GET /api/program-executions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "programId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "audienceId": "123e4567-e89b-12d3-a456-426614174000",
    "flowId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "scheduled",
    "totalContacts": 1,
    "contactsCompleted": 1,
    "contactsFailed": 1,
    "contactsPending": 1,
    "contactsInProgress": 1,
    "scheduledStartAt": "2026-02-16T20:48:53.613Z",
    "scheduledStopAt": "2026-02-16T20:48:53.613Z",
    "actualStartAt": "2026-02-16T20:48:53.613Z",
    "actualEndAt": "2026-02-16T20:48:53.613Z",
    "createdAt": "2026-02-16T20:48:53.613Z",
    "updatedAt": "2026-02-16T20:48:53.613Z"
  }
]

Get execution

get

Authorizations

BearerAuth

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

200

Execution details

application/json

401

Unauthorized

404

Execution not found

get

/program-executions/{id}

HTTPcURLJavaScriptPython

GET /api/program-executions/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "programId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "audienceId": "123e4567-e89b-12d3-a456-426614174000",
  "flowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "scheduled",
  "totalContacts": 1,
  "contactsCompleted": 1,
  "contactsFailed": 1,
  "contactsPending": 1,
  "contactsInProgress": 1,
  "scheduledStartAt": "2026-02-16T20:48:53.613Z",
  "scheduledStopAt": "2026-02-16T20:48:53.613Z",
  "actualStartAt": "2026-02-16T20:48:53.613Z",
  "actualEndAt": "2026-02-16T20:48:53.613Z",
  "createdAt": "2026-02-16T20:48:53.613Z",
  "updatedAt": "2026-02-16T20:48:53.613Z"
}

Cancel execution

delete

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

Authorizations

BearerAuth

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

204

Execution cancelled

401

Unauthorized

404

Execution not found

delete

/program-executions/{id}

HTTPcURLJavaScriptPython

DELETE /api/program-executions/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Pause execution

patch

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

Authorizations

BearerAuth

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

200

Execution paused

application/json

400

Execution not in running state

401

Unauthorized

404

Execution not found

patch

/program-executions/{id}/pause

HTTPcURLJavaScriptPython

PATCH /api/program-executions/{id}/pause HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "programId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "audienceId": "123e4567-e89b-12d3-a456-426614174000",
  "flowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "scheduled",
  "totalContacts": 1,
  "contactsCompleted": 1,
  "contactsFailed": 1,
  "contactsPending": 1,
  "contactsInProgress": 1,
  "scheduledStartAt": "2026-02-16T20:48:53.613Z",
  "scheduledStopAt": "2026-02-16T20:48:53.613Z",
  "actualStartAt": "2026-02-16T20:48:53.613Z",
  "actualEndAt": "2026-02-16T20:48:53.613Z",
  "createdAt": "2026-02-16T20:48:53.613Z",
  "updatedAt": "2026-02-16T20:48:53.613Z"
}

Resume execution

patch

Resume a paused execution.

Authorizations

BearerAuth

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

200

Execution resumed

application/json

400

Execution not in paused state

401

Unauthorized

404

Execution not found

patch

/program-executions/{id}/resume

HTTPcURLJavaScriptPython

PATCH /api/program-executions/{id}/resume HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "programId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "audienceId": "123e4567-e89b-12d3-a456-426614174000",
  "flowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "scheduled",
  "totalContacts": 1,
  "contactsCompleted": 1,
  "contactsFailed": 1,
  "contactsPending": 1,
  "contactsInProgress": 1,
  "scheduledStartAt": "2026-02-16T20:48:53.613Z",
  "scheduledStopAt": "2026-02-16T20:48:53.613Z",
  "actualStartAt": "2026-02-16T20:48:53.613Z",
  "actualEndAt": "2026-02-16T20:48:53.613Z",
  "createdAt": "2026-02-16T20:48:53.613Z",
  "updatedAt": "2026-02-16T20:48:53.613Z"
}