{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}},"ScopeHeaderOptional":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"CommunicationContact":{"properties":{"channel":{"$ref":"#/components/schemas/ContactChannel"},"communicationContactId":{"description":"Unique identifier for this communication contact.","type":"string"},"contactAddress":{"$ref":"#/components/schemas/ContactAddress"},"contactPurpose":{"$ref":"#/components/schemas/ContactPurpose"},"creationDateTime":{"description":"UTC timestamp of when this communication contact was created.","format":"date-time","type":"string"},"lastUpdatedDateTime":{"description":"UTC timestamp of the most recent update to this communication contact.","format":"date-time","type":"string"},"preferredContact":{"description":"Whether this is the advertiser\u0027s preferred contact method when multiple contacts exist for the same purpose (e.g., prefers phone over email for account support).","type":"boolean"},"timeZone":{"$ref":"#/components/schemas/TimeZoneIana"}},"required":["channel","communicationContactId","contactAddress","contactPurpose"],"type":"object"},"CommunicationContactContactChannelFilter":{"properties":{"include":{"description":"**Channel Enum:**\n| Channel | Description |\n| --- | --- |\n| `EMAIL` | Email address. |\n| `PHONE` | Phone number. |","items":{"$ref":"#/components/schemas/ContactChannel"},"maxItems":2,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CommunicationContactContactPurposeFilter":{"properties":{"include":{"description":"**ContactPurpose Enum:**\n| ContactPurpose | Description |\n| --- | --- |\n| `ACCOUNT_SUPPORT` | Account support and troubleshooting communications. |","items":{"$ref":"#/components/schemas/ContactPurpose"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"CommunicationContactCreate":{"properties":{"channel":{"$ref":"#/components/schemas/ContactChannel"},"contactAddress":{"$ref":"#/components/schemas/ContactAddress"},"contactPurpose":{"$ref":"#/components/schemas/ContactPurpose"},"preferredContact":{"description":"Whether this is the advertiser\u0027s preferred contact method when multiple contacts exist for the same purpose (e.g., prefers phone over email for account support).","type":"boolean"},"timeZone":{"$ref":"#/components/schemas/TimeZoneIana"}},"required":["channel","contactAddress","contactPurpose"],"type":"object"},"CommunicationContactMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/CommunicationContactMultiStatusSuccess"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"CommunicationContactMultiStatusSuccess":{"properties":{"communicationContact":{"$ref":"#/components/schemas/CommunicationContact"},"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"}},"required":["communicationContact","index"],"type":"object"},"CommunicationContactSuccessResponse":{"properties":{"communicationContacts":{"items":{"$ref":"#/components/schemas/CommunicationContact"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"ContactAddress":{"description":"The address where the advertiser can be reached — either an email address or a phone number.\n\n| ContactAddress | Description |\n|------|------|\n| `emailAddress` | Email address. |\n| `phoneNumber` | Phone number. |\n","format":"password","oneOf":[{"properties":{"emailAddress":{"type":"string"}},"required":["emailAddress"],"title":"emailAddress","type":"object"},{"properties":{"phoneNumber":{"type":"string"}},"required":["phoneNumber"],"title":"phoneNumber","type":"object"}]},"ContactChannel":{"description":"Supported channels for contacting an advertiser.\n**ContactChannel Enum:**\n\n| ContactChannel | Description |\n|------|------|\n| `EMAIL` | Email address. |\n| `PHONE` | Phone number. |\n","enum":["EMAIL","PHONE"],"type":"string"},"ContactPurpose":{"description":"Purposes for which a communication contact can be registered.\n**ContactPurpose Enum:**\n\n| ContactPurpose | Description |\n|------|------|\n| `ACCOUNT_SUPPORT` | Account support and troubleshooting communications. |\n","enum":["ACCOUNT_SUPPORT"],"type":"string"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"CreateCommunicationContactRequest":{"properties":{"communicationContacts":{"items":{"$ref":"#/components/schemas/CommunicationContactCreate"},"maxItems":10,"minItems":1,"type":"array"}},"required":["communicationContacts"],"type":"object"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n\n| ErrorCode | Description |\n|------|------|\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n","enum":["BAD_REQUEST","CONTENT_TOO_LARGE","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":9,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"QueryCommunicationContactRequest":{"properties":{"channelFilter":{"$ref":"#/components/schemas/CommunicationContactContactChannelFilter"},"contactPurposeFilter":{"$ref":"#/components/schemas/CommunicationContactContactPurposeFilter"},"maxResults":{"default":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TimeZoneIana":{"description":"Each enum member is in the IANA Time Zone Database\n**TimeZoneIana Enum:**\n\n| TimeZoneIana | Description |\n|------|------|\n| `America/Anchorage` | Alaska Time Zone (UTC-09:00) |\n| `America/Caracas` | Venezuela Time Zone (UTC-04:00) |\n| `America/Chicago` | Central Time Zone (UTC-06:00) |\n| `America/Denver` | Mountain Time Zone (UTC-07:00) |\n| `America/Halifax` | Atlantic Time Zone (UTC-04:00) |\n| `America/Los_Angeles` | Pacific Time Zone (UTC-08:00) |\n| `America/Mexico_City` | Central Mexico Time Zone (UTC-06:00) |\n| `America/New_York` | Eastern Time Zone (UTC-05:00) |\n| `America/Sao_Paulo` | Brasilia Time Zone (UTC-03:00) |\n| `America/St_Johns` | Newfoundland Time Zone (UTC-03:30) |\n| `Asia/Almaty` | Kazakhstan Time Zone (UTC+06:00) |\n| `Asia/Baghdad` | Arabian Time Zone (UTC+03:00) |\n| `Asia/Bangkok` | Indochina Time Zone (UTC+07:00) |\n| `Asia/Dubai` | Gulf Time Zone (UTC+04:00) |\n| `Asia/Hong_Kong` | Hong Kong Time Zone (UTC+08:00) |\n| `Asia/Kabul` | Afghanistan Time Zone (UTC+04:30) |\n| `Asia/Kathmandu` | Nepal Time Zone (UTC+05:45) |\n| `Asia/Kolkata` | India Time Zone (UTC+05:30) |\n| `Asia/Magadan` | Magadan Time Zone (UTC+11:00) |\n| `Asia/Riyadh` | Saudi Arabia Time Zone (UTC+03:00) |\n| `Asia/Shanghai` | China Time Zone (UTC+08:00) |\n| `Asia/Singapore` | Singapore Time Zone (UTC+08:00) |\n| `Asia/Tehran` | Iran Time Zone (UTC+03:30) |\n| `Asia/Tokyo` | Japan Time Zone (UTC+09:00) |\n| `Asia/Yekaterinburg` | Yekaterinburg Time Zone (UTC+05:00) |\n| `Asia/Yerevan` | Armenia Time Zone (UTC+04:00) |\n| `Atlantic/Azores` | Azores Time Zone (UTC-01:00) |\n| `Atlantic/South_Georgia` | South Georgia Time Zone (UTC-02:00) |\n| `Australia/Brisbane` | Australian Eastern Time Zone (UTC+10:00) |\n| `Australia/Darwin` | Australian Central Time Zone (UTC+09:30) |\n| `Australia/Sydney` | Australian Eastern Time Zone (UTC+10:00/+11:00) |\n| `EET` | Eastern European Time Zone (UTC+02:00) |\n| `Europe/Amsterdam` | Central European Time Zone (UTC+01:00) |\n| `Europe/Istanbul` | Turkey Time Zone (UTC+03:00) |\n| `Europe/London` | British Time Zone (UTC+00:00) |\n| `Europe/Paris` | Central European Time Zone (UTC+01:00) |\n| `Europe/Stockholm` | Central European Time Zone (UTC+01:00) |\n| `Indian/Cocos` | Cocos Islands Time Zone (UTC+06:30) |\n| `Pacific/Auckland` | New Zealand Time Zone (UTC+12:00/+13:00) |\n| `Pacific/Fiji` | Fiji Time Zone (UTC+12:00) |\n| `Pacific/Honolulu` | Hawaii Time Zone (UTC-10:00) |\n| `Pacific/Kwajalein` | Marshall Islands Time Zone (UTC+12:00) |\n| `Pacific/Midway` | Samoa Time Zone (UTC-11:00) |\n| `UTC` | Coordinated Universal Time (UTC+00:00) |\n","enum":["America/Anchorage","America/Caracas","America/Chicago","America/Denver","America/Halifax","America/Los_Angeles","America/Mexico_City","America/New_York","America/Sao_Paulo","America/St_Johns","Asia/Almaty","Asia/Baghdad","Asia/Bangkok","Asia/Dubai","Asia/Hong_Kong","Asia/Kabul","Asia/Kathmandu","Asia/Kolkata","Asia/Magadan","Asia/Riyadh","Asia/Shanghai","Asia/Singapore","Asia/Tehran","Asia/Tokyo","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/South_Georgia","Australia/Brisbane","Australia/Darwin","Australia/Sydney","EET","Europe/Amsterdam","Europe/Istanbul","Europe/London","Europe/Paris","Europe/Stockholm","Indian/Cocos","Pacific/Auckland","Pacific/Fiji","Pacific/Honolulu","Pacific/Kwajalein","Pacific/Midway","UTC"],"type":"string","x-enum-varnames":["AMERICA_ANCHORAGE","AMERICA_CARACAS","AMERICA_CHICAGO","AMERICA_DENVER","AMERICA_HALIFAX","AMERICA_LOS_ANGELES","AMERICA_MEXICO_CITY","AMERICA_NEW_YORK","AMERICA_SAO_PAULO","AMERICA_ST_JOHNS","ASIA_ALMATY","ASIA_BAGHDAD","ASIA_BANGKOK","ASIA_DUBAI","ASIA_HONG_KONG","ASIA_KABUL","ASIA_KATHMANDU","ASIA_KOLKATA","ASIA_MAGADAN","ASIA_RIYADH","ASIA_SHANGHAI","ASIA_SINGAPORE","ASIA_TEHRAN","ASIA_TOKYO","ASIA_YEKATERINBURG","ASIA_YEREVAN","ATLANTIC_AZORES","ATLANTIC_SOUTH_GEORGIA","AUSTRALIA_BRISBANE","AUSTRALIA_DARWIN","AUSTRALIA_SYDNEY","EET","EUROPE_AMSTERDAM","EUROPE_ISTANBUL","EUROPE_LONDON","EUROPE_PARIS","EUROPE_STOCKHOLM","INDIAN_COCOS","PACIFIC_AUCKLAND","PACIFIC_FIJI","PACIFIC_HONOLULU","PACIFIC_KWAJALEIN","PACIFIC_MIDWAY","UTC"]},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p_ALL.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p_ALL.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p_ALL.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p_ALL.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p_ALL.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p_ALL.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p_ALL.json))","title":"CommunicationContacts API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/create/communicationContacts":{"post":{"description":"Creates a communication contact for the authenticated advertiser, binding a contact address to a specific channel and purpose.\n\n**Requires one of these permissions**:\n[\"account_edit\"]","operationId":"CreateCommunicationContact","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommunicationContactRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunicationContactMultiStatusResponse"}}},"description":"CreateCommunicationContact 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["CommunicationContacts"]}},"/adsApi/v1/query/communicationContacts":{"post":{"description":"Returns communication contacts for the authenticated advertiser, optionally filtered by channel or contact purpose.\n\n**Requires one of these permissions**:\n[\"account_view\", \"account_edit\"]","operationId":"QueryCommunicationContact","parameters":[{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeaderOptional"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommunicationContactRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunicationContactSuccessResponse"}}},"description":"QueryCommunicationContact 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["CommunicationContacts"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}