> ## Documentation Index > Fetch the complete documentation index at: https://help.awin.com/llms.txt > Use this file to discover all available pages before exploring further. # Replace a publisher's partnership tags > 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; `partnershipTags` is missing or not an array of objects with a `name`; 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. ## OpenAPI ````json PUT /v1/advertisers/{advertiserId}/publishers/{publisherId}/partnership-tags { "openapi": "3.0.3", "info": { "title": "Awin Public API", "version": "0.1.0" }, "servers": [ { "url": "https://api.awin.com/public", "description": "Production" } ], "tags": [ { "name": "Advertisers", "description": "Endpoints for advertiser accounts." }, { "name": "Advertisers > Partnerships", "description": "Advertiser partnerships with publishers." }, { "name": "Advertisers > Tracking links", "description": "Advertiser tracking links." }, { "name": "Advertisers > Billing", "description": "Advertiser billing and prepayments." }, { "name": "Publishers", "description": "Endpoints for publisher accounts." }, { "name": "Publishers > Partnerships", "description": "Publisher partnerships with advertisers." }, { "name": "Publishers > Transactions", "description": "Publisher transactions." }, { "name": "Publishers > Payments", "description": "Publisher payments and payment details." } ], "paths": { "/v1/advertisers/{advertiserId}/publishers/{publisherId}/partnership-tags": { "x-awin-owner": "hqteambeagle", "parameters": [ { "$ref": "#/components/parameters/AdvertiserId" }, { "$ref": "#/components/parameters/PublisherId" } ], "put": { "tags": [ "Advertisers > Partnerships" ], "operationId": "replacePublisherPartnershipTags", "summary": "Replace a publisher's partnership tags", "description": "Use this to set the partnership tags an advertiser gives to one publisher.\n\nReplaces the publisher's tags with the ones named in the request: tags not\nlisted are removed from the publisher, and an empty list removes them all.\nA name that matches no existing tag creates that tag on the advertiser\naccount. Returns the publisher's tags after the change.\n\nSide effects: creates tags that do not exist yet and changes which tags the\npublisher carries. Tags removed from a publisher are not deleted from the\nadvertiser account. Repeating a call with the same body leaves the same\nresult, so no `Idempotency-Key` is required.\n\nThe caller must belong to the advertiser account and hold at least the\nFull Access role on it; otherwise the request is rejected with `403`.\n\nErrors:\n- `400`: the body is missing or not valid JSON; `partnershipTags` is missing\n or not an array of objects with a `name`; a name is empty or longer than 55\n characters; names are repeated; there are more than 1000 tags; the body\n contains an unknown field; or a path parameter is malformed.\n- `404`: the advertiser or publisher does not exist, or the publisher has\n no partnership with this advertiser.\n- `415`: the request does not carry a JSON content type.", "x-awin-public-api-authorization": { "accountType": "advertiser", "minRole": "userFullAccess" }, "x-awin-audience": "public", "requestBody": { "$ref": "#/components/requestBodies/PublisherPartnershipTagsReplace" }, "responses": { "200": { "description": "The publisher's partnership tags after the change.", "content": { "application/json": { "schema": { "type": "object", "required": [ "results" ], "properties": { "results": { "type": "array", "maxItems": 1000, "description": "The publisher's partnership tags, ordered by `name` ascending.", "items": { "$ref": "#/components/schemas/PublisherPartnershipTag" } } } } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "$ref": "#/components/responses/UnexpectedError" } }, "security": [ { "patBearer": [] } ] } } }, "components": { "parameters": { "AdvertiserId": { "name": "advertiserId", "in": "path", "required": true, "description": "Identifier of the advertiser account.", "schema": { "type": "string", "pattern": "^[0-9]+$", "example": "1001" } }, "PublisherId": { "name": "publisherId", "in": "path", "required": true, "description": "Identifier of the publisher account.", "schema": { "type": "string", "pattern": "^[0-9]+$", "example": "45678" } } }, "requestBodies": { "PublisherPartnershipTagsReplace": { "description": "The tags the publisher should have, replacing its current tags.", "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "partnershipTags" ], "properties": { "partnershipTags": { "type": "array", "maxItems": 1000, "uniqueItems": true, "description": "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.", "items": { "$ref": "#/components/schemas/PublisherPartnershipTag" }, "example": [ { "name": "Top performers" }, { "name": "Seasonal" } ] } } }, "example": { "partnershipTags": [ { "name": "Top performers" }, { "name": "Seasonal" } ] } } } } }, "schemas": { "PublisherPartnershipTag": { "type": "object", "description": "A partnership tag an advertiser has given to one publisher.", "required": [ "name" ], "properties": { "name": { "$ref": "#/components/schemas/name" } } }, "name": { "type": "string", "minLength": 1, "maxLength": 55, "description": "Name of the tag, as shown in the Awin UI. Unique per advertiser.", "example": "Top performers" }, "ValidationProblem": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "type": "object", "description": "A problem detail carrying the RFC 9457 extension member `errors`, used where a request fails validation on one or more specific fields.", "properties": { "errors": { "type": "array", "description": "One entry per field that failed validation.", "items": { "type": "object", "required": [ "pointer", "detail" ], "properties": { "pointer": { "type": "string", "description": "An [RFC 6901](https://www.rfc-editor.org/rfc/rfc6901) JSON Pointer to the offending field in the request.", "example": "/name" }, "detail": { "type": "string", "description": "A human-readable explanation of this field's failure.", "example": "must be 100 characters or fewer" } } } } } } ] }, "Problem": { "type": "object", "description": "Problem details for an HTTP API error, as defined by [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). Served as `application/problem+json`.", "required": [ "title", "status", "detail", "code" ], "properties": { "type": { "type": "string", "format": "uri-reference", "default": "https://help.awin.com/apis/error", "description": "A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.", "example": "https://help.awin.com/apis/error" }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.", "example": "Not Found" }, "status": { "type": "integer", "description": "The HTTP status code, repeated here for convenience.", "example": 404 }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.", "example": "Resource not found with that ID" }, "instance": { "type": "string", "format": "uri-reference", "description": "A URI reference identifying this specific occurrence, typically the request path.", "example": "/v1/advertisers/12345/prepayments" }, "code": { "type": "string", "description": "A stable, machine-readable error code. It does not change when `detail` is reworded, so clients branch on `code`, never on `detail`.", "enum": [ "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" ], "example": "NOT_FOUND" } } } }, "headers": { "RateLimitLimit": { "description": "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.", "schema": { "type": "integer", "minimum": 1, "example": 5 } }, "RateLimitRemaining": { "description": "Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 0, "example": 0 } }, "RateLimitReset": { "description": "Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 0, "example": 1 } }, "RetryAfter": { "description": "Number of seconds to wait before retrying the request.", "required": true, "schema": { "type": "integer", "minimum": 0, "example": 1 } } }, "responses": { "BadRequest": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblem" }, "example": { "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" } ] } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "Unauthorized": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Unauthorized", "status": 401, "detail": "No valid credentials were supplied with the request", "code": "UNAUTHORIZED" } } } }, "Forbidden": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "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" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "NotFound": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Not Found", "status": 404, "detail": "Resource not found with that ID", "code": "NOT_FOUND" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "UnsupportedMediaType": { "description": "Unsupported Media Type", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Unsupported Media Type", "status": 415, "detail": "Content-Type must be application/json", "code": "UNSUPPORTED_MEDIA_TYPE" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "TooManyRequests": { "description": "Too Many Requests", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "userRateLimitExceeded": { "value": { "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": { "value": { "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": { "value": { "type": "https://help.awin.com/apis/error", "title": "Too Many Requests", "status": 429, "detail": "Rate limit exceeded", "code": "TOO_MANY_REQUESTS" } } } } } }, "ServiceUnavailable": { "description": "Service Unavailable", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Service Unavailable", "status": 503, "detail": "The service is temporarily unavailable", "code": "SERVICE_UNAVAILABLE" } } } }, "UnexpectedError": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Internal Server Error", "status": 500, "detail": "An unexpected error occurred", "code": "INTERNAL_ERROR" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } } }, "securitySchemes": { "patBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Personal Access Token, sent as `Authorization: Bearer `." } } } } ````