Programs

Calling campaign management

List programs

get

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 programs

application/json

401

Unauthorized

get

/programs

HTTPcURLJavaScriptPython

GET /api/programs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "audienceId": "123e4567-e89b-12d3-a456-426614174000",
    "flowId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "draft",
    "startAt": "2026-02-16T20:43:36.369Z",
    "stopAt": "2026-02-16T20:43:36.369Z",
    "didPool": [
      "text"
    ],
    "retryStrategy": {
      "type": "none"
    },
    "pauseWindows": {
      "sunday": [
        {
          "startAt": {
            "hour": 1,
            "minute": 1
          },
          "endAt": {
            "hour": 1,
            "minute": 1
          }
        }
      ],
      "monday": [
        {
          "startAt": {
            "hour": 1,
            "minute": 1
          },
          "endAt": {
            "hour": 1,
            "minute": 1
          }
        }
      ],
      "tuesday": [
        {
          "startAt": {
            "hour": 1,
            "minute": 1
          },
          "endAt": {
            "hour": 1,
            "minute": 1
          }
        }
      ],
      "wednesday": [
        {
          "startAt": {
            "hour": 1,
            "minute": 1
          },
          "endAt": {
            "hour": 1,
            "minute": 1
          }
        }
      ],
      "thursday": [
        {
          "startAt": {
            "hour": 1,
            "minute": 1
          },
          "endAt": {
            "hour": 1,
            "minute": 1
          }
        }
      ],
      "friday": [
        {
          "startAt": {
            "hour": 1,
            "minute": 1
          },
          "endAt": {
            "hour": 1,
            "minute": 1
          }
        }
      ],
      "saturday": [
        {
          "startAt": {
            "hour": 1,
            "minute": 1
          },
          "endAt": {
            "hour": 1,
            "minute": 1
          }
        }
      ],
      "advanced": [
        {
          "startAt": "2026-02-16T20:43:36.369Z",
          "endAt": "2026-02-16T20:43:36.369Z"
        }
      ]
    },
    "createdAt": "2026-02-16T20:43:36.369Z",
    "updatedAt": "2026-02-16T20:43:36.369Z"
  }
]

Create program

post

Create a new calling campaign program.

Authorizations

BearerAuth

AuthorizationstringRequired

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

Body

application/json

namestringRequired

audienceIdstring · uuidRequired

flowIdstring · uuidRequired

startAtstring · date-timeRequired

stopAtstring · date-timeOptional

didPoolstring[]Required

retryStrategyone ofRequired

or

or

Responses

201

Program created

application/json

400

Invalid request

401

Unauthorized

post

/programs

HTTPcURLJavaScriptPython

POST /api/programs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 876

{
  "name": "text",
  "audienceId": "123e4567-e89b-12d3-a456-426614174000",
  "flowId": "123e4567-e89b-12d3-a456-426614174000",
  "startAt": "2026-02-16T20:43:36.369Z",
  "stopAt": "2026-02-16T20:43:36.369Z",
  "didPool": [
    "text"
  ],
  "retryStrategy": {
    "type": "none"
  },
  "pauseWindows": {
    "sunday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "friday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "advanced": [
      {
        "startAt": "2026-02-16T20:43:36.369Z",
        "endAt": "2026-02-16T20:43:36.369Z"
      }
    ]
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "audienceId": "123e4567-e89b-12d3-a456-426614174000",
  "flowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "draft",
  "startAt": "2026-02-16T20:43:36.369Z",
  "stopAt": "2026-02-16T20:43:36.369Z",
  "didPool": [
    "text"
  ],
  "retryStrategy": {
    "type": "none"
  },
  "pauseWindows": {
    "sunday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "friday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "advanced": [
      {
        "startAt": "2026-02-16T20:43:36.369Z",
        "endAt": "2026-02-16T20:43:36.369Z"
      }
    ]
  },
  "createdAt": "2026-02-16T20:43:36.369Z",
  "updatedAt": "2026-02-16T20:43:36.369Z"
}

Get program

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

Program details

application/json

401

Unauthorized

404

Program not found

get

/programs/{id}

HTTPcURLJavaScriptPython

GET /api/programs/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "audienceId": "123e4567-e89b-12d3-a456-426614174000",
  "flowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "draft",
  "startAt": "2026-02-16T20:43:36.369Z",
  "stopAt": "2026-02-16T20:43:36.369Z",
  "didPool": [
    "text"
  ],
  "retryStrategy": {
    "type": "none"
  },
  "pauseWindows": {
    "sunday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "friday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "advanced": [
      {
        "startAt": "2026-02-16T20:43:36.369Z",
        "endAt": "2026-02-16T20:43:36.369Z"
      }
    ]
  },
  "createdAt": "2026-02-16T20:43:36.369Z",
  "updatedAt": "2026-02-16T20:43:36.369Z"
}

Delete program

delete

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

Program deleted

No content

401

Unauthorized

404

Program not found

delete

/programs/{id}

HTTPcURLJavaScriptPython

DELETE /api/programs/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update program

patch

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

Body

application/json

namestringOptional

audienceIdstring · uuidOptional

flowIdstring · uuidOptional

startAtstring · date-timeOptional

stopAtstring · date-timeOptional

didPoolstring[]Optional

retryStrategyone ofOptional

or

or

Responses

200

Program updated

application/json

401

Unauthorized

404

Program not found

patch

/programs/{id}

HTTPcURLJavaScriptPython

PATCH /api/programs/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 876

{
  "name": "text",
  "audienceId": "123e4567-e89b-12d3-a456-426614174000",
  "flowId": "123e4567-e89b-12d3-a456-426614174000",
  "startAt": "2026-02-16T20:43:36.369Z",
  "stopAt": "2026-02-16T20:43:36.369Z",
  "didPool": [
    "text"
  ],
  "retryStrategy": {
    "type": "none"
  },
  "pauseWindows": {
    "sunday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "friday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "advanced": [
      {
        "startAt": "2026-02-16T20:43:36.369Z",
        "endAt": "2026-02-16T20:43:36.369Z"
      }
    ]
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "audienceId": "123e4567-e89b-12d3-a456-426614174000",
  "flowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "draft",
  "startAt": "2026-02-16T20:43:36.369Z",
  "stopAt": "2026-02-16T20:43:36.369Z",
  "didPool": [
    "text"
  ],
  "retryStrategy": {
    "type": "none"
  },
  "pauseWindows": {
    "sunday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "monday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "tuesday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "wednesday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "thursday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "friday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "saturday": [
      {
        "startAt": {
          "hour": 1,
          "minute": 1
        },
        "endAt": {
          "hour": 1,
          "minute": 1
        }
      }
    ],
    "advanced": [
      {
        "startAt": "2026-02-16T20:43:36.369Z",
        "endAt": "2026-02-16T20:43:36.369Z"
      }
    ]
  },
  "createdAt": "2026-02-16T20:43:36.369Z",
  "updatedAt": "2026-02-16T20:43:36.369Z"
}

Launch program execution

post

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

201

Execution launched

application/json

400

Execution already running or audience empty

401

Unauthorized

404

Program not found

post

/programs/{id}/launch

HTTPcURLJavaScriptPython

POST /api/programs/{id}/launch HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "executionId": "123e4567-e89b-12d3-a456-426614174000"
}

List program executions

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

List of executions

application/json

401

Unauthorized

404

Program not found

get

/programs/{id}/executions

HTTPcURLJavaScriptPython

GET /api/programs/{id}/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:43:36.369Z",
    "scheduledStopAt": "2026-02-16T20:43:36.369Z",
    "actualStartAt": "2026-02-16T20:43:36.369Z",
    "actualEndAt": "2026-02-16T20:43:36.369Z",
    "createdAt": "2026-02-16T20:43:36.369Z",
    "updatedAt": "2026-02-16T20:43:36.369Z"
  }
]