Starts a Campaign

POST 
/v1/campaigns/:campaignId/start

A Campaign can only be started if the Account has a balance greater than 0.

Request

Path Parameters

campaignId stringrequired

The Campaign identifier to start.

Responses

200

OK

application/json

Schema

Schema

timestamp date-timerequired

An ISO 8601 timestamp

Example (from schema)

{
  "timestamp": "2024-07-29T15:51:28.071Z"
}

default

Error

application/json

Schema

Schema

code int32

An error status code describing the response.

Enum Value	Description
0	OK
1	Cancelled
2	Unknown
3	InvalidArgument
4	DeadlineExceeded
5	NotFound
6	AlreadyExists
7	PermissionDenied
8	ResourceExhausted
9	FailedPrecondition
10	Aborted
11	OutOfRange
12	Unimplemented
13	Internal
14	Unavailable
15	DataLoss
16	Unauthenticated

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

message string

A developer-facing error message

details

object[]

A list of messages containing details about the errors

Array [

@type stringrequired

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...