Add an advertising category

The key is derived from the label when absent and cannot equal a platform key.

Scope suppressions.manage

Body

labelstringrequiredmin length 1max length 80

keystring

sortOrderintegermin 0max 10000

Returns

5 fields of the 201 answer

keystringrequired

labelstringrequired

sourceenumrequired

platformorganisation

sortOrderintegerrequired

archivedbooleanrequired

Responses

201Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

422Validation failed

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

Request

curl -X POST https://api.postbuddy.nl/v1/advertising-categories \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "First name"
  }'

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.advertisingCategories.create({
  body: {
    label: 'First name',
  },
});

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.advertising_categories.create({
    "label": "First name",
})

Response

{
  "key": "first_name",
  "label": "First name",
  "source": "platform",
  "sortOrder": 1,
  "archived": false
}

{
  "type": "https://docs.postbuddy.nl/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "code": "validation_failed",
  "detail": "Validation failed",
  "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
  "errors": [
    {
      "field": "recipient.postalCode",
      "code": "invalid_string",
      "message": "Invalid postal code"
    }
  ]
}