campaign

Changed on
get/api/v1/campaign/{id}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in cookie sessionid
    • none

Path parameters

idinteger required

A unique integer value identifying this campaign.

Query parameters

format'csv' | 'json'

Response

resource_uristring uri required
idinteger required
namestring required
slugstring required
urlstring uri
descriptionstring
start_datestring date-time nullable
activeboolean

Changes

  • f5a1531aecbeRevision changes
    • breaking

      for the path request parameter id, the type changed from string to integer

    • info

      api operation id retrieveCampaign removed and replaced with campaign_retrieve

    • info

      the endpoint scheme security cookieAuth was added to the API

    • info

      api tag campaign added

    • info

      api tag api removed

    • info

      added the new optional query request parameter format

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response's property pattern ^(?:[a-z0-9.+-]*)://(?:[^\s:@/]+(?::[^\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z¡-￿0-9](?:[a-z¡-￿0-9-]{0,61}[a-z¡-￿0-9])?(?:\.(?!-)[a-z¡-￿0-9-]{1,63}(?<!-))*\.(?!-)(?:[a-z¡-￿-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\s]*)?\z was removed for the status (media type: application/json)

    • info

      the response's property pattern ^(?:[a-z0-9.+-]*)://(?:[^\s:@/]+(?::[^\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z¡-￿0-9](?:[a-z¡-￿0-9-]{0,61}[a-z¡-￿0-9])?(?:\.(?!-)[a-z¡-￿0-9-]{1,63}(?<!-))*\.(?!-)(?:[a-z¡-￿-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\s]*)?\z was removed for the status (media type: text/csv)