Invite Advertiser User

POST

/api/public/users/advertisers/invite

Invite a new advertiser user

const url = 'https://backend.podscribe.ai/api/public/users/advertisers/invite';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"advertiserName":"example","email":"hello@example.com","tabs":["ads"],"teamMembers":["hello@example.com"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://backend.podscribe.ai/api/public/users/advertisers/invite"

payload = {
    "advertiserName": "example",
    "email": "hello@example.com",
    "tabs": ["ads"],
    "teamMembers": ["hello@example.com"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

curl --request POST \
  --url https://backend.podscribe.ai/api/public/users/advertisers/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "advertiserName": "example", "email": "hello@example.com", "tabs": [ "ads" ], "teamMembers": [ "hello@example.com" ] }'

Request Body^required

application/json

advertiserName

required

The name of the advertiser

string

email

required

The email address of the user to invite

string<email>

tabs

The list of tabs to grant access to (optional).

If omitted, the invitee will have full access to all tabs.
If provided, the invitee will only have access to the specified tabs.
Available values:
- ads — Airchecks
- simple_campaigns — Simple Campaigns
- simple_overview — Simple Overview
- tag_debug — Tag Setup
- simple_overview_show — Show-level Reporting (Overview > Show tab)
simple_overview_show requires simple_overview.

Array

ads simple_campaigns simple_overview tag_debug simple_overview_show

teamMembers

Email addresses of existing users to associate with the advertiser as team members

Array<string<email>>

Response Body

Successfully invited advertiser user

application/json

message

Success message

string

Response example

{
  "message": "example"
}

Invite Advertiser User

Request Bodyrequired

Response Body

Request Body^required