Delete a campaign

DELETE

/v1/campaigns/{campaignId}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.grona.ai/v1/campaigns/CMP-1024"

  req, _ := http.NewRequest("DELETE", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.grona.ai/v1/campaigns/CMP-1024")
  .delete(null)
  .addHeader("Authorization", "Bearer <token>")
  .build();

Response response = client.newCall(request).execute();

const url = 'https://api.grona.ai/v1/campaigns/CMP-1024';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.grona.ai/v1/campaigns/CMP-1024 \
  --header 'Authorization: Bearer <token>'

Deletes the campaign and the variations created with it. Deletion is permanent and frees the campaign’s externalId for reuse. data.id is always Grona’s id, even when you call it with your externalId.

If you retry a delete, address the campaign by Grona’s id, never by externalId. Once the first attempt frees the externalId, a retry could delete a new campaign that took it.

Grona then removes the campaign from your site script. Visitors can still see it until the refreshed script reaches them, so the change is not instant.

Authorizations

secretKeyBearer
secretKeyHeader

Parameters

Path Parameters

campaignId

required

string

/^[A-Za-z0-9_.:-]{1,128}$/

Grona’s campaign id or your externalId. If a value matches both, Grona’s id wins.

Example

CMP-1024

Responses

200

Deleted.

application/json

object

data

required

object

required

Grona’s id of the deleted campaign.

string

deletedVariationIds

required

The variations deleted with the campaign.

Array<string>

meta

required

object

workspaceId

required

The workspace resolved from the secret key.

string

Example

{
  "data": {
    "id": "671a3c90e4b0a1f2c3d40011",
    "deletedVariationIds": [
      "671a3c90e4b0a1f2c3d40012"
    ]
  },
  "meta": {
    "workspaceId": "65e8a1c47d2f9b03e6a15c42"
  }
}

400

The request is invalid. error.code is invalid_request and error.message says what to change. Nothing in the request was applied.

application/json

object

error

required

object

code

required

Stable and machine-readable. Branch on this, and on the HTTP status for codes you do not know.

string

Allowed values: invalid_request unauthorized not_found conflict internal_error

message

required

Human-readable. The wording can change, so do not parse it.

string

Example

{
  "error": {
    "code": "invalid_request",
    "message": "The campaign id is not a valid id."
  }
}

401

The secret key is missing, malformed, unknown or revoked. error.code is unauthorized.

application/json

object

error

required

object

code

required

Stable and machine-readable. Branch on this, and on the HTTP status for codes you do not know.

string

Allowed values: invalid_request unauthorized not_found conflict internal_error

message

required

Human-readable. The wording can change, so do not parse it.

string

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key."
  }
}

404

No campaign with this id or externalId exists in the key’s workspace. error.code is not_found.

application/json

object

error

required

object

code

required

Stable and machine-readable. Branch on this, and on the HTTP status for codes you do not know.

string

Allowed values: invalid_request unauthorized not_found conflict internal_error

message

required

Human-readable. The wording can change, so do not parse it.

string

Example

{
  "error": {
    "code": "not_found",
    "message": "Campaign not found."
  }
}

429

Too many requests. Retry with exponential backoff and jitter, and wait at least as long as Retry-After when it is present. Branch on the status code; the body is not guaranteed to use the error envelope.

Headers

Retry-After

string

How long to wait before retrying, in seconds or as an HTTP date.

500

Unexpected server error. error.code is internal_error. Retry with backoff; if it persists, contact support@grona.ai with the time of the request and the endpoint.

application/json

object

error

required

object

code

required

Stable and machine-readable. Branch on this, and on the HTTP status for codes you do not know.

string

Allowed values: invalid_request unauthorized not_found conflict internal_error

message

required

Human-readable. The wording can change, so do not parse it.

string

Example

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side."
  }
}

503

Temporarily unavailable. Retry with exponential backoff and jitter, and wait at least as long as Retry-After when it is present. Branch on the status code; the body is not guaranteed to use the error envelope.

Headers

Retry-After

string

How long to wait before retrying, in seconds or as an HTTP date.