v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

Domain Slug

createCampaignDomainSlug

Create a Domain Slug for the specified Campaign

post/campaigns/{campaign}/domain-slugs

Path parameters

campaigninteger required

Example:227362

Primary identifier of specified Campaign

Request body

links_to_donation_pageboolean

Indicates whether the slug should reference the Donation Page for the DomainSlug's Fundraising Entity

valuestring

Value of the Domain Slug

domain_idinteger

Primary identifier of associated Domain. If none provided, the default Domain will be used.

Example request

{
  "value": "15thbowlathon",
  "domain_id": 791
}

Response

Success

created_atstring date-time

Date/time of initial record creation

deleted_atstring date-time nullable

Date/time that record was deleted

domain_idinteger

Primary identifier of associated Domain

fundraising_entity_idinteger

Primary identifier of associated Fundraising Entity

fundraising_entity_type'organization' | 'campaign' | 'fundraising_page' | 'fundraising_team'

Type of associated Fundraising Entity

idinteger

Primary identifier of record

links_to_donation_pageboolean

Indicates whether the slug should reference the Donation Page for the DomainSlug's Fundraising Entity

domain_masking_urlstring

The domain masking url of the organization

updated_atstring date-time

Date/time when record was last updated

valuestring

Value of the Domain Slug

Example response

{
  "created_at": "2021-04-23T08:23:21Z",
  "deleted_at": "2021-04-23T08:23:21Z",
  "domain_id": 1,
  "fundraising_entity_id": 227362,
  "fundraising_entity_type": "campaign",
  "id": 235,
  "domain_masking_url": "subdomain.domain.tld",
  "updated_at": "2021-04-23T10:25:03Z",
  "value": "15thbowlathon"
}