1. Workspace Organisation Users
Avid PubSuite Partner API
  • Default module
    • Pubsuite API Introduction
    • Getting Started
      • Authentication
      • Response Format
      • Error Codes
      • Usage Limits
    • Endpoints
      • Endpoints / Resources Introduction
      • Global Pubsuite Reference Libaries
      • Workspace Org
        • Workspace Organisation
      • Workspace Organisation Users
        • List Users
          GET
        • User Details
          GET
        • Upsert User
          POST
        • Delete User
          DELETE
      • Advertiser Accounts
        • Advertiser Accounts List
        • Account Detail
        • Account Delete
        • Account Create
        • Account Update
      • Advertiser Account Members
        • Advertiser Account Members
        • Adv Account Member Detail
        • Account Delete
        • Advertiser Account Member Create
        • Account Update
      • Campaigns
        • Campaign Body Parameters
        • Campaigns
        • Campaign
        • Delete Campaign
        • Campaign Details
        • Update Campaign
      • Phases
        • Phase Body Parameters
        • Phases List
        • Phase
        • Phase Detail
        • Delete Phase
        • Phase Update
      • Content
        • Content Body Parameters
        • Contents
        • Content Detail
        • Create Content
        • Delete Content
        • Update Content
      • Distributions
        • Distribution Body Parameters
        • Distributions List
        • Create Distributions
        • Delete Distribution
        • Distribution Details
        • Distribution Update
      • Publisher Profiles
        • Coming Soon
        • Publisher Profiles
        • Publisher Profile
        • Delete Publisher Profile
      • Publisher Products
        • Coming Soon
      • Data Sources
        • Coming Soon
      • Webhooks
        • Services
        • Create/Update Service
        • Registered Webhooks
        • Create Webhook
        • Update Webhook
        • Delete Webhook
    • Outbound Events
      • Outbound Events
  • Commercial - Avid Webhook - Order Events
    • post_campaign_status
      • Receive Avid campaign (Adpoint Order) status updated event
    • post_content_status
      • Receive content status (Adpoint Ad Group) updated event updated event
    • Schemas
      • post_campaign_status_request
      • post_content_status_request
      • 200_post_campaign_status_response
      • 200_post_content_status_response
      • error_response
      • error
  1. Workspace Organisation Users

Upsert User

POST
https://api.avidpubsuite.com/v2/organisation-users
This endpoint is used to create or update an organisation user within a workspace. This endpoint requires Bearer Token authentication, with the API key generated from Super Admin (Console) → System Settings → API Platform (the same credentials used for the Full Campaign endpoint can be used here). If user_id is provided in the request body, the system will perform a lookup and update the existing user; if user_id is not provided, a new user will be created with a system-generated ID. The required fields include user_email, user_first_name, user_last_name, and roles, where role_type = 1 represents Campaign Manager and role_type = 2 represents Content Editor (internal role types). The custom_fields object is optional and, if provided and not null, will be added or updated accordingly; if null or omitted, no changes will be applied to custom fields.

Request

Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
Header Params

Body Params application/json

Example
{
    "user_id": 67507881,
    "user_email": "Alana49@yahoo.com",
    "user_first_name": "Norbert",
    "user_last_name": "Block",
    "roles": [
        {
            "role_type": 1
        },
        {
            "role_type": 2
        }
    ],
    "custom_fields": null
}

Responses

🟢200OK
application/json
Bodyapplication/json

Example
{
    "success": true,
    "message": "string",
    "data": {
        "user_id": 0,
        "user_first_name": "string",
        "user_last_name": "string",
        "user_email": "user@example.com",
        "custom_fields": {},
        "okta_id": "string",
        "auth0id": "string",
        "roles": [
            {
                "name": "string",
                "role_type": 0
            }
        ]
    }
}
🟠401Unauthorized
🔴500Internal Server Error
🟠404Resource Not Found
Previous
User Details
Next
Delete User