Update a campaign

PUT

campaigns

{campaign}

Update a campaign

curl --request PUT \
  --url https://api.givebutter.com/v1/campaigns/{campaign} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "published": true,
  "public": true,
  "title": "<string>",
  "subtitle": "<string>",
  "website": "<string>",
  "description": "<string>",
  "goal": 1,
  "end_at": "2023-11-07T05:31:56Z",
  "short_code": "<string>",
  "slug": "<string>",
  "beneficiary_id": 123,
  "timezone": "<string>",
  "currency": "USD",
  "default_appeal_id": 123,
  "cover": {
    "url": "<string>"
  },
  "settings": [
    {
      "name": "hide_time_remaining",
      "value": true
    }
  ]
}
'

import requests

url = "https://api.givebutter.com/v1/campaigns/{campaign}"

payload = {
    "published": True,
    "public": True,
    "title": "<string>",
    "subtitle": "<string>",
    "website": "<string>",
    "description": "<string>",
    "goal": 1,
    "end_at": "2023-11-07T05:31:56Z",
    "short_code": "<string>",
    "slug": "<string>",
    "beneficiary_id": 123,
    "timezone": "<string>",
    "currency": "USD",
    "default_appeal_id": 123,
    "cover": { "url": "<string>" },
    "settings": [
        {
            "name": "hide_time_remaining",
            "value": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    published: true,
    public: true,
    title: '<string>',
    subtitle: '<string>',
    website: '<string>',
    description: '<string>',
    goal: 1,
    end_at: '2023-11-07T05:31:56Z',
    short_code: '<string>',
    slug: '<string>',
    beneficiary_id: 123,
    timezone: '<string>',
    currency: 'USD',
    default_appeal_id: 123,
    cover: {url: '<string>'},
    settings: [{name: 'hide_time_remaining', value: true}]
  })
};

fetch('https://api.givebutter.com/v1/campaigns/{campaign}', 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.givebutter.com/v1/campaigns/{campaign}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'published' => true,
    'public' => true,
    'title' => '<string>',
    'subtitle' => '<string>',
    'website' => '<string>',
    'description' => '<string>',
    'goal' => 1,
    'end_at' => '2023-11-07T05:31:56Z',
    'short_code' => '<string>',
    'slug' => '<string>',
    'beneficiary_id' => 123,
    'timezone' => '<string>',
    'currency' => 'USD',
    'default_appeal_id' => 123,
    'cover' => [
        'url' => '<string>'
    ],
    'settings' => [
        [
                'name' => 'hide_time_remaining',
                'value' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.givebutter.com/v1/campaigns/{campaign}"

	payload := strings.NewReader("{\n  \"published\": true,\n  \"public\": true,\n  \"title\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"website\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal\": 1,\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"short_code\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"beneficiary_id\": 123,\n  \"timezone\": \"<string>\",\n  \"currency\": \"USD\",\n  \"default_appeal_id\": 123,\n  \"cover\": {\n    \"url\": \"<string>\"\n  },\n  \"settings\": [\n    {\n      \"name\": \"hide_time_remaining\",\n      \"value\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.givebutter.com/v1/campaigns/{campaign}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"published\": true,\n  \"public\": true,\n  \"title\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"website\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal\": 1,\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"short_code\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"beneficiary_id\": 123,\n  \"timezone\": \"<string>\",\n  \"currency\": \"USD\",\n  \"default_appeal_id\": 123,\n  \"cover\": {\n    \"url\": \"<string>\"\n  },\n  \"settings\": [\n    {\n      \"name\": \"hide_time_remaining\",\n      \"value\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.givebutter.com/v1/campaigns/{campaign}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"published\": true,\n  \"public\": true,\n  \"title\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"website\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal\": 1,\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"short_code\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"beneficiary_id\": 123,\n  \"timezone\": \"<string>\",\n  \"currency\": \"USD\",\n  \"default_appeal_id\": 123,\n  \"cover\": {\n    \"url\": \"<string>\"\n  },\n  \"settings\": [\n    {\n      \"name\": \"hide_time_remaining\",\n      \"value\": true\n    }\n  ]\n}"

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

{
  "id": "<string>",
  "code": "<string>",
  "account_id": "<string>",
  "event_id": "<string>",
  "type": "<string>",
  "title": "<string>",
  "subtitle": "<string>",
  "description": "<string>",
  "slug": "<string>",
  "url": "<string>",
  "goal": 123,
  "raised": 123,
  "donors": 123,
  "currency": "<string>",
  "cover": "<string>",
  "status": "<string>",
  "timezone": "<string>",
  "end_at": "<string>",
  "settings": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>",
  "event": {
    "title": "<string>",
    "type": "<string>",
    "location_name": "<string>",
    "address_formatted": "<string>",
    "google_place_id": "<string>",
    "start_at": "<string>",
    "end_at": "<string>",
    "timezone": "<string>",
    "details": "<string>",
    "private": "<string>",
    "tickets_required": "<string>",
    "livestream": "<string>",
    "livestream_start_at": "<string>",
    "livestream_end_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign

integer

required

The campaign ID

Body

application/json

published

boolean

public

boolean

type

enum<string>

Available options:

general,

collect,

fundraise,

event

Maximum string length: 255

title

string

Maximum string length: 150

subtitle

string | null

Maximum string length: 255

website

string<uri> | null

Maximum string length: 255

description

string | null

goal

integer | null

Required range: x >= 0

end_at

string<date-time> | null

short_code

string | null

Maximum string length: 255

slug

string

Maximum string length: 255

beneficiary_id

integer | null

timezone

string | null

Maximum string length: 255

currency

enum<string>

Available options:

USD

default_appeal_id

integer | null

cover

object

Show child attributes

settings

A campaign setting. The name field determines the expected shape of value.

Show child attributes

Response

CampaignResource

string

required

code

string

required

account_id

string

required

event_id

string

required

type

string

required

title

string

required

subtitle

string

required

description

string

required

slug

string

required

url

string

required

goal

integer | null

required

raised

number

required

donors

integer

required

currency

string

required

cover

string

required

status

string

required

timezone

string

required

end_at

string

required

settings

CampaignSettingResource · object[]

required

Show child attributes

created_at

string

required

updated_at

string

required

event

EventResource · object

Show child attributes

Delete a campaign

⌘I

Update a campaign

curl --request PUT \
  --url https://api.givebutter.com/v1/campaigns/{campaign} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "published": true,
  "public": true,
  "title": "<string>",
  "subtitle": "<string>",
  "website": "<string>",
  "description": "<string>",
  "goal": 1,
  "end_at": "2023-11-07T05:31:56Z",
  "short_code": "<string>",
  "slug": "<string>",
  "beneficiary_id": 123,
  "timezone": "<string>",
  "currency": "USD",
  "default_appeal_id": 123,
  "cover": {
    "url": "<string>"
  },
  "settings": [
    {
      "name": "hide_time_remaining",
      "value": true
    }
  ]
}
'

import requests

url = "https://api.givebutter.com/v1/campaigns/{campaign}"

payload = {
    "published": True,
    "public": True,
    "title": "<string>",
    "subtitle": "<string>",
    "website": "<string>",
    "description": "<string>",
    "goal": 1,
    "end_at": "2023-11-07T05:31:56Z",
    "short_code": "<string>",
    "slug": "<string>",
    "beneficiary_id": 123,
    "timezone": "<string>",
    "currency": "USD",
    "default_appeal_id": 123,
    "cover": { "url": "<string>" },
    "settings": [
        {
            "name": "hide_time_remaining",
            "value": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    published: true,
    public: true,
    title: '<string>',
    subtitle: '<string>',
    website: '<string>',
    description: '<string>',
    goal: 1,
    end_at: '2023-11-07T05:31:56Z',
    short_code: '<string>',
    slug: '<string>',
    beneficiary_id: 123,
    timezone: '<string>',
    currency: 'USD',
    default_appeal_id: 123,
    cover: {url: '<string>'},
    settings: [{name: 'hide_time_remaining', value: true}]
  })
};

fetch('https://api.givebutter.com/v1/campaigns/{campaign}', 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.givebutter.com/v1/campaigns/{campaign}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'published' => true,
    'public' => true,
    'title' => '<string>',
    'subtitle' => '<string>',
    'website' => '<string>',
    'description' => '<string>',
    'goal' => 1,
    'end_at' => '2023-11-07T05:31:56Z',
    'short_code' => '<string>',
    'slug' => '<string>',
    'beneficiary_id' => 123,
    'timezone' => '<string>',
    'currency' => 'USD',
    'default_appeal_id' => 123,
    'cover' => [
        'url' => '<string>'
    ],
    'settings' => [
        [
                'name' => 'hide_time_remaining',
                'value' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.givebutter.com/v1/campaigns/{campaign}"

	payload := strings.NewReader("{\n  \"published\": true,\n  \"public\": true,\n  \"title\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"website\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal\": 1,\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"short_code\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"beneficiary_id\": 123,\n  \"timezone\": \"<string>\",\n  \"currency\": \"USD\",\n  \"default_appeal_id\": 123,\n  \"cover\": {\n    \"url\": \"<string>\"\n  },\n  \"settings\": [\n    {\n      \"name\": \"hide_time_remaining\",\n      \"value\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.givebutter.com/v1/campaigns/{campaign}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"published\": true,\n  \"public\": true,\n  \"title\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"website\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal\": 1,\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"short_code\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"beneficiary_id\": 123,\n  \"timezone\": \"<string>\",\n  \"currency\": \"USD\",\n  \"default_appeal_id\": 123,\n  \"cover\": {\n    \"url\": \"<string>\"\n  },\n  \"settings\": [\n    {\n      \"name\": \"hide_time_remaining\",\n      \"value\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.givebutter.com/v1/campaigns/{campaign}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"published\": true,\n  \"public\": true,\n  \"title\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"website\": \"<string>\",\n  \"description\": \"<string>\",\n  \"goal\": 1,\n  \"end_at\": \"2023-11-07T05:31:56Z\",\n  \"short_code\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"beneficiary_id\": 123,\n  \"timezone\": \"<string>\",\n  \"currency\": \"USD\",\n  \"default_appeal_id\": 123,\n  \"cover\": {\n    \"url\": \"<string>\"\n  },\n  \"settings\": [\n    {\n      \"name\": \"hide_time_remaining\",\n      \"value\": true\n    }\n  ]\n}"

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

{
  "id": "<string>",
  "code": "<string>",
  "account_id": "<string>",
  "event_id": "<string>",
  "type": "<string>",
  "title": "<string>",
  "subtitle": "<string>",
  "description": "<string>",
  "slug": "<string>",
  "url": "<string>",
  "goal": 123,
  "raised": 123,
  "donors": 123,
  "currency": "<string>",
  "cover": "<string>",
  "status": "<string>",
  "timezone": "<string>",
  "end_at": "<string>",
  "settings": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>",
  "event": {
    "title": "<string>",
    "type": "<string>",
    "location_name": "<string>",
    "address_formatted": "<string>",
    "google_place_id": "<string>",
    "start_at": "<string>",
    "end_at": "<string>",
    "timezone": "<string>",
    "details": "<string>",
    "private": "<string>",
    "tickets_required": "<string>",
    "livestream": "<string>",
    "livestream_start_at": "<string>",
    "livestream_end_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Introduction

Endpoints

Authorizations

Path Parameters

Body

Response