Skip to content

User Roles and Permissions

Every authenticated user is assigned one of four standard roles within their organization. A role determines which API operations the user is allowed to call:

Role Access Level Description
super_admin Full Organization owner. Can manage organization settings, invite admins/users, and perform all operations.
admin Elevated Can manage campaigns, budgets, line items, creatives, and standard users within the organization.
user Standard Day-to-day operator. Can create, edit, and launch campaigns, line items, and view reporting.
read_only Viewer Can only view campaigns, creatives, and analytics reports. Operations that create, update or delete resources are blocked.

Access to each API operation is protected by a permission. A permission is named after the API operation it protects: the ListCampaigns operation requires the ListCampaigns permission, the UpsertUsers operation requires the UpsertUsers permission, and so on. A user can call an operation only if one of their roles grants that permission.

Permissions are pre-defined for each role. The full list is available in the Detailed Permissions & Roles table below.

Access is evaluated on every request:

  • A valid JWT bearer token is required. Requests with a missing, expired, or invalid token are rejected with 401 Unauthorized.
  • The user’s role must grant the permission required by the operation being called. Otherwise the request is rejected with 403 Forbidden.
  • Operations that do not appear in the table below are not available to any role, even with a valid token.
Endpoint Required permission Authorized roles
GET /line-items/campaigns ListCampaigns super_admin, admin, user, read_only
POST /line-items/campaigns GetCampaigns super_admin, admin, user, read_only
PUT /line-items/campaigns CreateCampaign super_admin, admin, user
DELETE /line-items/campaigns/{id} DeleteCampaign super_admin, admin
GET /auth/user GetUser super_admin, admin, user, read_only
GET /auth/users/{id} GetUserByID super_admin
PUT /auth/users UpsertUsers super_admin

The table below lists every permission available on the platform along with the roles authorized to use it:

PermissionDescriptionAuthorized Roles
GetAudits

Permission for method GetAudits: Returns the audits of the given creatives and dynamic content optimizations.

super_adminadminuserread_only
UpsertAudits

Permission for method UpsertAudits: Creates or updates multiple audits.

super_adminadminuser
ListCreatives

Permission for method ListCreatives: Returns a list of creatives

super_adminadminuserread_only
GetCreatives

Permission for method GetCreatives: Get creatives for given creative IDs

super_adminadminuserread_only
GetCreative

Permission for method GetCreative: Returns the creative details by ID

super_adminadminuserread_only
UpsertCreatives

Permission for method UpsertCreatives: Creates or updates multiple creatives.

super_adminadminuser
UploadAsset

Permission for method UploadAsset: Uploads a creative asset file (main image, native icon, video, ...) and returns its public URL. The returned URL can then be referenced when upserting a creative, for example as its `source_url` or as a native `metadata.icon_image_url`. Content validation is applied for HTML files and they should include integrity attribute for <script> and <link> tags.

super_adminadminuser
ListHTMLTemplateNames

Permission for method ListHTMLTemplateNames: Returns a list of HTML creative template names

super_adminadminuserread_only
GetHTMLTemplateByName

Permission for method GetHTMLTemplateByName: Returns the HTML creative template by name

super_adminadminuserread_only
RenderCreative

Permission for method RenderCreative: Returns the HTML creative template rendered with given parameters.

super_adminadminuserread_only
ListAllRoles

Permission for method ListAllRoles: List all platform roles

super_adminadmin
ListUsers

Permission for method ListUsers: List users with optional search, sortable by `first_name`, `last_name`, `updated_at`

super_adminadmin
GetUserByID

Permission for method GetUserByID: Returns a user by its unique identifier

super_adminadmin
GetUser

Permission for method GetUser: Returns current user

super_adminadminuserread_only
UpsertUsers

Permission for method UpsertUsers: Creates or updates multiple users. Only users with role `admin` or `super_admin` can call this endpoint. The `super_admin` role is reserved for the account owner, whose roles cannot be changed, and only the owner can update the owner. A user row breaking these rules is rejected with a `403` in its `users[i]` error detail, code `SUPER_ADMIN_RESERVED` or `OWNER_READ_ONLY`. The other rows are still written but not returned: list the users again before resending, as rows without an `id` would be created twice.

super_adminadmin
UpdateUsers

Permission for method UpdateUsers: Updates current users. Only first name and last name can be modified through this endpoint.

super_adminadmin
InviteUsers

Permission for method InviteUsers: Invites users by ids and sends activation links.

super_adminadmin
Logout

Permission for method Logout: Logs out the current user by invalidating the access and refresh tokens

super_adminadminuserread_only
SetupTOTP

Permission for method SetupTOTP: Starts TOTP enrollment for the current user and returns the otpauth URI and QR code

super_adminadminuserread_only
ActivateTOTP

Permission for method ActivateTOTP: Confirms TOTP enrollment for the current user with a valid code and returns one-time recovery codes

super_adminadminuserread_only
SetupEmailOTP

Permission for method SetupEmailOTP: Starts email one-time password enrollment for the current user and sends a code to their address

super_adminadminuserread_only
ActivateEmailOTP

Permission for method ActivateEmailOTP: Confirms email one-time password enrollment for the current user with a valid code

super_adminadminuserread_only
DisableMFA

Permission for method DisableMFA: Disables MFA for the current user after re-authenticating with their password

super_adminadminuserread_only
GenerateAPIKey

Permission for method GenerateAPIKey: Generates a new API key for the current user and returns it in clear. Any previous key stops working. Only the account owner can generate a key, other users get a `403`. The platform stores only a hash of the key and cannot show it again.

super_adminadminuser
CreateCheckoutSession

Permission for method CreateCheckoutSession: Creates the embedded Stripe checkout session topping up the wallet of the account and returns its client secret. The customer enters the amount and picks the currency in the checkout, within the limits set on the top-up price in Stripe.

super_admin
GetBanker

Permission for method GetBanker: Returns the wallet of the current account

super_adminadminuserread_only
ListPayments

Permission for method ListPayments: Returns the wallet top-up payments of the current account, sortable by `id`, `amount`, `status`, `created_at` and `updated_at`

super_admin
GetPaymentInvoiceURL

Permission for method GetPaymentInvoiceURL: Returns the URL of the Stripe hosted page of the invoice of a payment of the current account, from which the PDF can be downloaded. Returns a `404` when the payment has no invoice yet.

super_admin
GetPricingPolicies

Permission for method GetPricingPolicies: Get pricing policies for given pricing policy IDs

super_adminadminuserread_only
UpsertPricingPolicies

Permission for method UpsertPricingPolicies: Creates or updates multiple pricing policies

super_adminadminuser
GetDynamicContentOptimizations

Permission for method GetDynamicContentOptimizations: Get dynamic content optimizations for given IDs

super_adminadminuserread_only
GetDynamicContentOptimization

Permission for method GetDynamicContentOptimization: Returns the dynamic content optimization details

super_adminadminuserread_only
UpsertDynamicContentOptimizations

Permission for method UpsertDynamicContentOptimizations: Creates or updates multiple dynamic content optimizations

super_adminadminuser
DeleteDynamicContentOptimizations

Permission for method DeleteDynamicContentOptimizations: Deletes multiple dynamic content optimizations

super_adminadmin
ListTags

Permission for method ListTags: Lists the tags of the account. The owner and the admins get every tag, the other delegates only get the tags assigned to them. Sortable by `id`, `name`, `created_at` or `updated_at`

super_adminadminuserread_only
UpsertTags

Permission for method UpsertTags: Creates or updates multiple tags of the account. A tag name is unique per account and cannot be changed once created

super_adminadmin
DeleteTags

Permission for method DeleteTags: Deletes multiple tags of the account. A tag still assigned to a user is refused

super_adminadmin
ListLineItems

Permission for method ListLineItems: Returns a list of line items

super_adminadminuserread_only
GetLineItems

Permission for method GetLineItems: Get line items for given IDs

super_adminadminuserread_only
UpsertLineItems

Permission for method UpsertLineItems: Creates or updates multiple line items

super_adminadminuser
DeleteLineItems

Permission for method DeleteLineItems: Deletes multiple line items

super_adminadmin
ListCampaigns

Permission for method ListCampaigns: Returns a list of campaigns

super_adminadminuserread_only
GetCampaign

Permission for method GetCampaign: Returns a campaign by its unique identifier

super_adminadminuserread_only
GetCampaigns

Permission for method GetCampaigns: Returns the campaigns matching the given unique identifiers. Identifiers that do not exist or are outside the caller's scope are left out of the response.

super_adminadminuserread_only
CreateCampaign

Permission for method CreateCampaign: Creates a campaign with line items

super_adminadminuser
UpdateCampaign

Permission for method UpdateCampaign: Updates a campaign by its unique identifier

super_adminadminuser
DeleteCampaign

Permission for method DeleteCampaign: Deletes a campaign by its unique identifierThis operation will succeed only when all associated line items have priorly been removed.

super_adminadmin
GetTargetings

Permission for method GetTargetings: Get targetings for given targeting IDs

super_adminadminuserread_only
GetTargetingByID

Permission for method GetTargetingByID: Returns the targeting by its unique identifier

super_adminadminuserread_only
UpsertTargetings

Permission for method UpsertTargetings: Creates or updates multiple targetings

super_adminadminuser
DeleteTargetings

Permission for method DeleteTargetings: Deletes multiple targetings

super_adminadmin
UploadTargetingDistributionChannels

Permission for method UploadTargetingDistributionChannels: Uploads a list of site domains, mobile application identifiers, digital out of home screen identifiers...

super_adminadminuser
UploadTargetingIFAList

Permission for method UploadTargetingIFAList: Uploads a list of Identifier for Advertisers (IFA)

super_adminadminuser
GetTrackings

Permission for method GetTrackings: Get trackings for given tracking IDs

super_adminadminuserread_only
GetTrackingByID

Permission for method GetTrackingByID: Returns the tracking by its unique identifier

super_adminadminuserread_only
UpsertTrackings

Permission for method UpsertTrackings: Creates or updates multiple trackings

super_adminadminuser
DeleteTrackings

Permission for method DeleteTrackings: Deletes multiple trackings

super_adminadminuser
ListProviders

Permission for method ListProviders: Returns a list of double tracking providers

super_adminadminuserread_only
GetFileByURI

Permission for method GetFileByURI: Get a file by its URI

super_adminadminuserread_only
GetAreaGeometries

Permission for method GetAreaGeometries: Get area geometries for given area geometry IDs

super_adminadminuserread_only
GetArea

Permission for method GetArea: Returns the area details by ID

super_adminadminuserread_only
GetAreas

Permission for method GetAreas: Get areas for given area IDs

super_adminadminuserread_only
UpsertArea

Permission for method UpsertArea: Creates or updates a geo area

super_adminadminuser
GetCurrencyRates

Permission for method GetCurrencyRates: Returns the stored exchange rates for the requested ISO 4217 currencies. Each value is the number of units of the currency per 1 USD, so the USD amount is obtained by dividing the currency amount by the value. USD is always available with a value of 1. A currency with no published rate is rejected instead of being dropped.

super_adminadminuserread_only
GetImpressionsRanges

Permission for method GetImpressionsRanges: Returns the impressions ranges

super_adminadminuserread_only
GetCampaignReporting

Permission for method GetCampaignReporting: Returns aggregated performance metrics for a campaign

super_adminadminuserread_only
GetCampaignReportingSeries

Permission for method GetCampaignReportingSeries: Returns performance metrics series over time for a campaign

super_adminadminuserread_only
GenerateCampaignReport

Permission for method GenerateCampaignReport: Starts the asynchronous generation of a CSV report covering a campaign, optionally over a date range, and returns the identifier of the report being generated. The report is generated in the background: it cannot be downloaded until the generation completes.

super_adminadminuserread_only
GetLineItemsReporting

Permission for method GetLineItemsReporting: Returns aggregated performance metrics for specific line items

super_adminadminuserread_only
GetLineItemsReportingSeries

Permission for method GetLineItemsReportingSeries: Returns performance metrics series over time for specific line items

super_adminadminuserread_only