Update advertiser's API access

PATCH 
/v1/account/apiaccess

Blocks or activates advertiser API access.

Use to restore access after a usage policy block.

Set apiAccessStatus to ACTIVE or BLOCKED.

Changes take 24 hours to take effect.

Advertisers who activate access are subject to the usage policy.

To check quota usage, see Get advertiser's API quota usage.

Set content type to application/json.

OAuth scope	Access token type
employer.advertising.account	Employer access token

Request

application/json

Body

required

apiAccessStatus string

Possible values: [ACTIVE, BLOCKED]

Advertiser API access. Valid values are:

• ACTIVE : Activates advertiser's access to API.

• BLOCKED : Blocks advertiser's access to API.

Responses

200

Success

application/json

Schema

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

• up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.

• next: The next page of entries in a paginated result.

• prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data

object

apiAccessStatus string

Possible values: [ACTIVE, BLOCKED]

Advertiser API access. Valid values are:

• ACTIVE : Activates advertiser's access to API.

• BLOCKED : Blocks advertiser's access to API.

employerId string

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": {
    "apiAccessStatus": "ACTIVE",
    "employerId": "48b4d2510d8a9493030cf19bb7654c9b"
  }
}

Example

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/account"
      }
    ]
  },
  "data": {
    "employerId": "48b4d2510d8a9493030cf19bb7654c9b",
    "apiAccessStatus": "ACTIVE"
  }
}

400

A request parameter is invalid.

The description field usually names the invalid parameter.

The description field also includes a detailed error message.

Unlike other error types, meta.errors can contain multiple INVALID_REQUEST errors.

Each INVALID_REQUEST error corresponds to one invalid parameter.

application/json

Schema

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

• up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.

• next: The next page of entries in a paginated result.

• prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "INVALID_REQUEST",
        "description": "<p>Bad parameter value: Unrecognized field (<code>class com.indeed.oyster.account.model.ImmutableUpdateApiAccess$Json</code>), not marked as ignorable.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

401

A request parameter is invalid.

The description field usually names the parameter.

The description field also includes a detailed error message.

Unlike other error types, meta.errors can contain multiple INVALID_REQUEST errors.

Each INVALID_REQUEST error corresponds to one invalid parameter.

application/json

Schema

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

• up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.

• next: The next page of entries in a paginated result.

• prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 401,
    "errors": [
      {
        "type": "INVALID_TOKEN",
        "description": "<p>Invalid OAuth access token.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

403

You do not have permission to access this API.

application/json

Schema

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

• up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.

• next: The next page of entries in a paginated result.

• prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 403,
    "errors": [
      {
        "type": "FORBIDDEN",
        "description": "<p>You don&#x27;t have permission to access this API.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/account"
      }
    ]
  },
  "data": null
}

404

The server encountered an unexpected error and did not return a response.

application/json

Schema

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

• up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.

• next: The next page of entries in a paginated result.

• prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "timestamp": 1745565919573,
    "status": 404,
    "error": "Not Found",
    "path": "/v1/account/apiacces"
  }
}

500

The server encountered an unexpected error and did not return a response.

application/json

Schema

Schema

meta

object

Response-related metadata.

status int32

HTTP status code of the response.

errors

object[]

Errors that prevented the request from being processed successfully.

If there are no errors, this value is null.

Array [

type string

Name of the error.

description string

Human-readable description of the problem.

]

rootLocation string

Base URL of the Sponsored Jobs API.

perPage int32

For endpoints that return paginated results, the effective maximum number of entries returned on one page.

The value may be smaller than the maximum you requested with the perPage parameter.

If the endpoint returns a single result or doesn't paginate, the value is null.

links

object[]

Resources related to the requested resource.

Array [

rel string

The relationship between the requested resource and the related resource. These values are commonly used:

• up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.

• next: The next page of entries in a paginated result.

• prev: The previous page of entries in a paginated result.

However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

href string

Endpoint URL of the related resource.

Can contain query string parameters.

To get the complete URL, append the href to rootLocation.

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 500,
    "errors": [
      {
        "type": "INTERNAL_SERVER_ERROR",
        "description": "<p>The server encountered an unexpected failure and did not provide a response.</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

Loading...

 

Was this page helpful?