Update a gift certificate

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/gift_certificates/gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "gift_certificate": {
      "expiry_date": "2027-12-31"
    }
  }'

from exsited import build_client

client = build_client()

response = client.gift_certificates.update_gift_certificate(
    "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f",
    {"gift_certificate": {"expiry_date": "2027-12-31"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.giftCertificates.updateGiftCertificate('gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f', {
    gift_certificate: {expiry_date: '2027-12-31'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->giftCertificates->updateGiftCertificate(
    'gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f',
    ['gift_certificate' => ['expiry_date' => '2027-12-31']],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.gift_certificates.gift_certificates_dto.GiftCertificatesDto.GiftCertificate;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<GiftCertificate> response = client.giftCertificates().updateGiftCertificate(
        "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f",
        Map.of("gift_certificate", Map.of("expiry_date", "2027-12-31")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.GiftCertificates.UpdateGiftCertificateAsync(
    "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f",
    new Dictionary<string, object?>
    {
        ["gift_certificate"] = new Dictionary<string, object?>
        {
            ["expiry_date"] = "2027-12-31",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.giftCertificates.updateGiftCertificate(
  'gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f',
  {
    'gift_certificate': {'expiry_date': '2027-12-31'},
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.GiftCertificates().UpdateGiftCertificate(context.Background(), "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f", map[string]any{
	"gift_certificate": map[string]any{"expiry_date": "2027-12-31"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "gift_certificate": {
    "accounting_code": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "activity_logs": [
      {
        "activity": "<string>"
      }
    ],
    "allocations": [
      {
        "account": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "created_by": "<unknown>",
        "created_on": "<string>",
        "date": "<string>",
        "href": "<string>",
        "id": "<string>",
        "last_updated_by": "<unknown>",
        "last_updated_on": "<string>",
        "object": "<string>",
        "status": "<string>",
        "type": "<string>",
        "version": 123
      }
    ],
    "amount": "<string>",
    "code": "<string>",
    "created_by": "<unknown>",
    "created_on": "<string>",
    "currency": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "expiry_date": "<string>",
    "href": "<string>",
    "id": "<string>",
    "issue_date": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "linked_item": "<unknown>",
    "object": "<string>",
    "remaining_balance": "<string>",
    "status": "<string>",
    "transactions": [
      {
        "accounting_code": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "amount": "<string>",
        "created_by": "<unknown>",
        "created_on": "<string>",
        "currency": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "date": "<string>",
        "href": "<string>",
        "id": "<string>",
        "last_updated_by": "<unknown>",
        "last_updated_on": "<string>",
        "object": "<string>",
        "reference": "<unknown>",
        "status": "<string>",
        "type": "<string>",
        "version": 123
      }
    ],
    "used_amount": "<string>",
    "version": 123
  }
}

PATCH

gift_certificates

{gc_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/gift_certificates/gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "gift_certificate": {
      "expiry_date": "2027-12-31"
    }
  }'

from exsited import build_client

client = build_client()

response = client.gift_certificates.update_gift_certificate(
    "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f",
    {"gift_certificate": {"expiry_date": "2027-12-31"}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.giftCertificates.updateGiftCertificate('gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f', {
    gift_certificate: {expiry_date: '2027-12-31'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->giftCertificates->updateGiftCertificate(
    'gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f',
    ['gift_certificate' => ['expiry_date' => '2027-12-31']],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.gift_certificates.gift_certificates_dto.GiftCertificatesDto.GiftCertificate;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<GiftCertificate> response = client.giftCertificates().updateGiftCertificate(
        "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f",
        Map.of("gift_certificate", Map.of("expiry_date", "2027-12-31")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.GiftCertificates.UpdateGiftCertificateAsync(
    "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f",
    new Dictionary<string, object?>
    {
        ["gift_certificate"] = new Dictionary<string, object?>
        {
            ["expiry_date"] = "2027-12-31",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.giftCertificates.updateGiftCertificate(
  'gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f',
  {
    'gift_certificate': {'expiry_date': '2027-12-31'},
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.GiftCertificates().UpdateGiftCertificate(context.Background(), "gc_5b2e8f1a7c3d4e9b0a6f2c4d8e1b3a7f", map[string]any{
	"gift_certificate": map[string]any{"expiry_date": "2027-12-31"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "gift_certificate": {
    "accounting_code": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "activity_logs": [
      {
        "activity": "<string>"
      }
    ],
    "allocations": [
      {
        "account": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "created_by": "<unknown>",
        "created_on": "<string>",
        "date": "<string>",
        "href": "<string>",
        "id": "<string>",
        "last_updated_by": "<unknown>",
        "last_updated_on": "<string>",
        "object": "<string>",
        "status": "<string>",
        "type": "<string>",
        "version": 123
      }
    ],
    "amount": "<string>",
    "code": "<string>",
    "created_by": "<unknown>",
    "created_on": "<string>",
    "currency": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "expiry_date": "<string>",
    "href": "<string>",
    "id": "<string>",
    "issue_date": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "linked_item": "<unknown>",
    "object": "<string>",
    "remaining_balance": "<string>",
    "status": "<string>",
    "transactions": [
      {
        "accounting_code": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "amount": "<string>",
        "created_by": "<unknown>",
        "created_on": "<string>",
        "currency": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "date": "<string>",
        "href": "<string>",
        "id": "<string>",
        "last_updated_by": "<unknown>",
        "last_updated_on": "<string>",
        "object": "<string>",
        "reference": "<unknown>",
        "status": "<string>",
        "type": "<string>",
        "version": 123
      }
    ],
    "used_amount": "<string>",
    "version": 123
  }
}

Send only the fields to change under gift_certificate. Set status to inactive to stop the certificate being used, and back to active to allow it again. To change the balance, use the amend call instead.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

gc_id

string

required

The gift certificate's id.

Body

application/json

gift_certificate

object

required

Show child attributes

Response

200 - application/json

The updated gift certificate, under gift_certificate.

gift_certificate

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response