Use this when a publisher wants to accept an advertiser's invitation to join their programme.
Accepts the pending invitation from that advertiser. The request body must
include termsAndConditionsAccepted set to true. Only pending invitations
can be accepted. On success it creates an active partnership, the invitation
is no longer pending, and the partnership is returned in the response.
Repeating a successful call returns 409.
The caller needs the Full Access role or higher on the publisher account.
Errors:
400: the body is missing or not valid JSON;termsAndConditionsAcceptedis missing or is not a boolean; the body contains an unknown field; or a path parameter is malformed.404: the advertiser or publisher does not exist, or no invitation from this advertiser exists for this publisher.409: the invitation is no longer pending or an active partnership already exists.415: the request does not carry a JSON content type.422:termsAndConditionsAcceptedisfalse; the advertiser's status does not allow starting a partnership; the publisher cannot accept invitations; or the advertiser status is not supported.
Personal Access Token, sent as Authorization: Bearer <token>.
Identifier of the publisher account.
Identifier of the advertiser account.
Must be true; false is rejected as a business-rule violation.
Invitation accepted; partnership created.
The partnership created by accepting an invitation.
Publisher account identifier.
Advertiser account identifier.
The partnership status after accepting the invitation.
UTC timestamp when the partnership was created.
Bad Request
{
"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"
}
]
}A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
One entry per field that failed validation.
A human-readable explanation of this field's failure.
Unauthorized
{
"type": "https://help.awin.com/apis/error",
"title": "Unauthorized",
"status": 401,
"detail": "No valid credentials were supplied with the request",
"code": "UNAUTHORIZED"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Forbidden
{
"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"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Not Found
{
"type": "https://help.awin.com/apis/error",
"title": "Not Found",
"status": 404,
"detail": "Resource not found with that ID",
"code": "NOT_FOUND"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Conflict
{
"type": "https://help.awin.com/apis/error",
"title": "Conflict",
"status": 409,
"detail": "Conflict between request and current state of resource",
"code": "CONFLICT"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Unsupported Media Type
{
"type": "https://help.awin.com/apis/error",
"title": "Unsupported Media Type",
"status": 415,
"detail": "Content-Type must be application/json",
"code": "UNSUPPORTED_MEDIA_TYPE"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Unprocessable Content
{
"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"
}
]
}A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
One entry per field that failed validation.
A human-readable explanation of this field's failure.
Too Many Requests
{
"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"
}{
"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"
}{
"type": "https://help.awin.com/apis/error",
"title": "Too Many Requests",
"status": 429,
"detail": "Rate limit exceeded",
"code": "TOO_MANY_REQUESTS"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Service Unavailable
{
"type": "https://help.awin.com/apis/error",
"title": "Service Unavailable",
"status": 503,
"detail": "The service is temporarily unavailable",
"code": "SERVICE_UNAVAILABLE"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Internal Server Error
{
"type": "https://help.awin.com/apis/error",
"title": "Internal Server Error",
"status": 500,
"detail": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.