Program Executions

Campaign execution lifecycle

List active executions

get

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/program-executions

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 /program-executions HTTP/1.1
Host: api.gomobile.io
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": "2025-12-19T15:55:52.223Z",
    "scheduledStopAt": "2025-12-19T15:55:52.223Z",
    "actualStartAt": "2025-12-19T15:55:52.223Z",
    "actualEndAt": "2025-12-19T15:55:52.223Z",
    "createdAt": "2025-12-19T15:55:52.223Z",
    "updatedAt": "2025-12-19T15:55:52.223Z"
  }
]

Get execution

get

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/program-executions/{id}

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 /program-executions/{id} HTTP/1.1
Host: api.gomobile.io
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": "2025-12-19T15:55:52.223Z",
  "scheduledStopAt": "2025-12-19T15:55:52.223Z",
  "actualStartAt": "2025-12-19T15:55:52.223Z",
  "actualEndAt": "2025-12-19T15:55:52.223Z",
  "createdAt": "2025-12-19T15:55:52.223Z",
  "updatedAt": "2025-12-19T15:55:52.223Z"
}

Cancel execution

delete

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/program-executions/{id}

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 /program-executions/{id} HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Pause execution

patch

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/program-executions/{id}/pause

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 /program-executions/{id}/pause HTTP/1.1
Host: api.gomobile.io
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": "2025-12-19T15:55:52.223Z",
  "scheduledStopAt": "2025-12-19T15:55:52.223Z",
  "actualStartAt": "2025-12-19T15:55:52.223Z",
  "actualEndAt": "2025-12-19T15:55:52.223Z",
  "createdAt": "2025-12-19T15:55:52.223Z",
  "updatedAt": "2025-12-19T15:55:52.223Z"
}

Resume execution

patch

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/program-executions/{id}/resume

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 /program-executions/{id}/resume HTTP/1.1
Host: api.gomobile.io
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": "2025-12-19T15:55:52.223Z",
  "scheduledStopAt": "2025-12-19T15:55:52.223Z",
  "actualStartAt": "2025-12-19T15:55:52.223Z",
  "actualEndAt": "2025-12-19T15:55:52.223Z",
  "createdAt": "2025-12-19T15:55:52.223Z",
  "updatedAt": "2025-12-19T15:55:52.223Z"
}