Get Campaign Details

curl --request GET \
  --url https://api.usewave.co/api/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usewave.co/api/v1/campaigns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usewave.co/api/v1/campaigns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.usewave.co/api/v1/campaigns/{id}"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usewave.co/api/v1/campaigns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "status": "LAUNCHED",
  "active": true,
  "messagesPerDay": 123,
  "workingDays": [
    "MONDAY"
  ],
  "workingHours": [
    "<string>"
  ],
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "increase_limit_gracefully": true,
  "timezone": "<string>",
  "lists": [],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

GET

api

campaigns

{id}

Get Campaign Details

curl --request GET \
  --url https://api.usewave.co/api/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usewave.co/api/v1/campaigns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usewave.co/api/v1/campaigns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.usewave.co/api/v1/campaigns/{id}"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usewave.co/api/v1/campaigns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "status": "LAUNCHED",
  "active": true,
  "messagesPerDay": 123,
  "workingDays": [
    "MONDAY"
  ],
  "workingHours": [
    "<string>"
  ],
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "increase_limit_gracefully": true,
  "timezone": "<string>",
  "lists": [],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters.",
  "details": "<unknown>"
}

Authorizations

Authorization

string

header

required

Enter your API key: wave_live_<token>

Path Parameters

string

required

Response

Successful Response

string<uuid>

required

Campaign ID

title

string

required

Campaign title

status

enum<string>

default:LAUNCHED

Available options:

CREATED,

LAUNCHED,

PENDING,

COMPLETED,

MESSAGING_COMPLETED

active

boolean

default:true

messagesPerDay

integer | null

workingDays

enum<string>[] | null

Available options:

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY,

SUNDAY

workingHours

string[] | null

account_id

string<uuid> | null

sequence_id

string<uuid> | null

increase_limit_gracefully

boolean | null

timezone

string | null

lists

string<uuid>[] | null

Attached audience list UUIDs

created_at

string<date-time> | null

updated_at

string<date-time> | null

Getting Started

Endpoints

Get Campaign Details

Authorizations

Path Parameters

Response