Reject a partnership application

Prev Next
Post
/v1/advertisers/{advertiserId}/publishers/{publisherId}/reject-application

Use this when an advertiser does not want to accept a publisher's application to join their programme.

Rejects the pending application from that publisher. The rejection reason is sent to the publisher in an email. Only pending applications can be rejected; a successful call changes the partnership status to rejected.

The request body must contain a reason. When reason is OTHER_SPECIFY, otherReason is also required. otherReason is not allowed with any other reason.

The caller needs the Full Access role or higher on the advertiser account.

Errors:

  • 400: the body is missing or not valid JSON; reason is missing or not an allowed value; otherReason is sent with any reason other than OTHER_SPECIFY, is missing for OTHER_SPECIFY, or is not 1 to 1000 characters; the body contains an unknown field; or a path parameter is malformed.
  • 404: the advertiser or publisher does not exist, or the publisher has not applied to this advertiser.
  • 409: the application was already rejected. Repeating a successful call returns 409.
  • 415: the request does not carry a JSON content type.
  • 422: the application is not pending for another reason, for example because the publisher is already a partner or was invited.
Security
HTTP
Type bearer

Personal Access Token, sent as Authorization: Bearer <token>.

Path parameters
advertiserId
stringRequired

Identifier of the advertiser account.

Pattern^[0-9]+$
Example1001
publisherId
stringRequired

Identifier of the publisher account.

Pattern^[0-9]+$
Example45678
Body parameters

The reason for rejecting the publisher's application.

standardReason

Standard reason

{
  "reason": "SITE_NOT_LIVE"
}
customReason

Custom reason

{
  "reason": "OTHER_SPECIFY",
  "otherReason": "Custom compliance requirement not met"
}
OneOf
Standard reason
object (Standard reason)
reason
string Required

The reason for rejecting the application. It is sent to the publisher in an email.

Valid values[ "PROFILE_INCOMPLETE", "NO_URL", "DEAD_URL", "SITE_NOT_LIVE", "IRRELEVANT_URL", "DOES_NOT_COMPLEMENT", "LACKS_DESCRIPTION", "UNSUPPORTED_PROMOTION_TYPE", "ADULT_CONTENT" ]
ExampleSITE_NOT_LIVE
Custom reason
object (Custom reason)
reason
string Required

Must be OTHER_SPECIFY. otherReason is then required.

Valid values[ "OTHER_SPECIFY" ]
ExampleOTHER_SPECIFY
otherReason
string Required

The reason in your own words. It is trimmed before its length is checked, so leading and trailing whitespace does not count towards the 1 to 1000 character limit. It is sent to the publisher in an email.

Min length1
Max length1000
ExampleCustom compliance requirement not met
Responses
204

Application rejected.

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
400

Bad Request

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Bad Request",
  "status": 400,
  "detail": "Required parameters are missing from the request",
  "code": "VALIDATION_FAILED",
  "errors": [
    {
      "pointer": "/name",
      "detail": "must be 100 characters or fewer"
    }
  ]
}
Expand All
object
type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
errors
Array of object

One entry per field that failed validation.

object
pointer
string

An RFC 6901 JSON Pointer to the offending field in the request.

Example/name
detail
string

A human-readable explanation of this field's failure.

Examplemust be 100 characters or fewer
401

Unauthorized

{
  "type": "https://help.awin.com/apis/error",
  "title": "Unauthorized",
  "status": 401,
  "detail": "No valid credentials were supplied with the request",
  "code": "UNAUTHORIZED"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
403

Forbidden

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Forbidden",
  "status": 403,
  "detail": "You do not have the correct privileges to access this resource",
  "code": "FORBIDDEN"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
404

Not Found

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Not Found",
  "status": 404,
  "detail": "Resource not found with that ID",
  "code": "NOT_FOUND"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
409

Conflict

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Conflict",
  "status": 409,
  "detail": "Conflict between request and current state of resource",
  "code": "CONFLICT"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
415

Unsupported Media Type

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Unsupported Media Type",
  "status": 415,
  "detail": "Content-Type must be application/json",
  "code": "UNSUPPORTED_MEDIA_TYPE"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
422

Unprocessable Content

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request was well-formed but could not be processed",
  "code": "BUSINESS_RULE_VIOLATION",
  "errors": [
    {
      "pointer": "/name",
      "detail": "value is too long after HTML sanitization"
    }
  ]
}
Expand All
object
type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
errors
Array of object

One entry per field that failed validation.

object
pointer
string

An RFC 6901 JSON Pointer to the offending field in the request.

Example/name
detail
string

A human-readable explanation of this field's failure.

Examplemust be 100 characters or fewer
429

Too Many Requests

Headers
Retry-After
integerRequired
Number of seconds to wait before retrying the request.
Minimum0
Example1
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
userRateLimitExceeded
{
  "type": "https://help.awin.com/apis/error",
  "title": "User rate limit exceeded",
  "status": 429,
  "detail": "You have exceeded your rate limit across the public API. Retry after the number of seconds in the Retry-After header",
  "code": "USER_RATE_LIMIT_EXCEEDED"
}
routeRateLimitExceeded
{
  "type": "https://help.awin.com/apis/error",
  "title": "Route rate limit exceeded",
  "status": 429,
  "detail": "This endpoint is receiving more requests than it can accept right now. Retry after the number of seconds in the Retry-After header",
  "code": "ROUTE_RATE_LIMIT_EXCEEDED"
}
tooManyRequests
{
  "type": "https://help.awin.com/apis/error",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "Rate limit exceeded",
  "code": "TOO_MANY_REQUESTS"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
503

Service Unavailable

Headers
Retry-After
integerRequired
Number of seconds to wait before retrying the request.
Minimum0
Example1
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "The service is temporarily unavailable",
  "code": "SERVICE_UNAVAILABLE"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
default

Internal Server Error

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND