user-settings

User Settings

GET accounts/:account_id/user_settings/:user_id¶

Retrieves user settings.

Resource URL¶

https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id

Parameters¶

Name	Description
account_id required	The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: `18ce54d4x5t`
user_id required	A reference to the user you are operating with in the request. Use GET users/lookup to retrieve a user ID for a screen name. Type: long Example: `756201191646691328`

Example Request¶

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328

Example Response¶

  {
    "request": {
      "params": {
        "account_id": "18ce54d4x5t",
        "user_id": "756201191646691328"
      }
    },
    "data": {
      "notification_email": "user@domain.com",
      "contact_phone": "",
      "contact_phone_extension": ""
    }
  }

PUT accounts/:account_id/user_settings/:user_id¶

Updates user settings. Requires user context. Not accessible by account admins.

Resource URL¶

https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id

Parameters¶

Name	Description
account_id required	The identifier for the leveraged account. Appears within the resource's path and GET accounts. The specified account must be associated with the authenticated user. Type: string Example: `18ce54d4x5t`
user_id required	A reference to the user you are operating with in the request. Use GET users/lookup to retrieve a user ID for a screen name. Type: long Example: `756201191646691328`
notification_email optional	Email to use for account notifications. Type: string Example: `user@domain.com`
contact_phone optional	Contact phone number. Type: string Example: `202-555-0128`
contact_phone_extension optional	Extension for contact `contact_phone`. Type: string Example: `1234`

Example Request¶

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='user@domain.com'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT"

Example Response¶

  {
    "request": {
      "params": {
        "account_id": "18ce54d4x5t",
        "user_id": "756201191646691328"
        "notification_email": "user@domain.com",
        "subscribed_campaign_events": [
          "ACCOUNT_PERFORMANCE",
          "PERFORMANCE_IMPROVEMENT"
        ]
      }
    },
    "data": {
      "notification_email": "user@domain.com",
      "contact_phone": "",
      "Contact_phone_extension": ""
    }
  }