Versions Compared

Version Old Version 3 New Version Current
Changes made by

Danny Hannah

Danny Hannah

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

Required

Type

Notes

name

(tick)

string

Must be unique

campaignManager

(error)

IRI string

IRI from /api/v4/users endpoint filtered by e.g
"campaignManager":"/api/v4/users/123"

accountManager

(error)

string

firstName

(tick)

string

lastName

(tick)

string

email

(tick)

string

telephone

(tick)

string

orgurl

(tick)

string

autosignContract

(tick)

boolean

If enabled, new campaigns will not need to be approved.

notes

(error)

string

useIoManagement

(tick)

boolean

Recommended to be false.

address

(tick)

object

address.building

(tick)

string

address.town

(tick)

string

address.postcode

(tick)

string

address.country

(tick)

IRI string

IRI from /api/v4/countries endpoint, e.g
"country":"/api/v4/countries/1"

Errors

Errors are returned in array format, and will return the impacted property name:

Code Block
{
    "@context": "/api/v4/contexts/ConstraintViolationList",
    "@type": "ConstraintViolationList",
    "hydra:title": "An error occurred",
    "hydra:description": "name: Advertiser with this name already exists.",
    "violations": [
        {
            "propertyPath": "name",
            "message": "Advertiser with this name already exists."
        }
    ]
}

...

Message

...

Code

...

Reason

...

Advertiser with this name already exists.

...

400

...

Advertiser name must be unique