Use this to set the partnership tags an advertiser gives to one publisher.
Replaces the publisher's tags with the ones named in the request: tags not listed are removed from the publisher, and an empty list removes them all. A name that matches no existing tag creates that tag on the advertiser account. Returns the publisher's tags after the change.
Side effects: creates tags that do not exist yet and changes which tags the
publisher carries. Tags removed from a publisher are not deleted from the
advertiser account. Repeating a call with the same body leaves the same
result, so no Idempotency-Key is required.
The caller must belong to the advertiser account and hold at least the
Full Access role on it; otherwise the request is rejected with 403.
Errors:
400: the body is missing or not valid JSON;partnershipTagsis missing or not an array of objects with aname; a name is empty or longer than 55 characters; names are repeated; there are more than 1000 tags; the body contains an unknown field; or a path parameter is malformed.404: the advertiser or publisher does not exist, or the publisher has no partnership with this advertiser.415: the request does not carry a JSON content type.
Personal Access Token, sent as Authorization: Bearer <token>.
Identifier of the advertiser account.
Identifier of the publisher account.
The tags the publisher should have, replacing its current tags.
{
"partnershipTags": [
{
"name": "Top performers"
},
{
"name": "Seasonal"
}
]
}The tags the publisher should have. Replaces the publisher's current tags: a tag not listed is removed from the publisher, and an empty array removes them all. A name that matches no existing tag creates that tag.
A partnership tag an advertiser has given to one publisher.
Name of the tag, as shown in the Awin UI. Unique per advertiser.
The publisher's partnership tags after the change.
The publisher's partnership tags, ordered by name ascending.
A partnership tag an advertiser has given to one publisher.
Name of the tag, as shown in the Awin UI. Unique per advertiser.
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.
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.
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.