openapi: 3.2.0
info:
title: Creatoriq Publisher API
contact:
name: CreatorIQ
url: https://www.creatoriq.com
email: support@creatoriq.com
license:
url: https://www.apache.org/licenses/LICENSE-2.0.html
name: Apache 2.0
termsOfService: https://www.creatoriq.com/legal/terms-of-use
version: '1.0'
description: 'Operations tagged Publisher across 2 of this provider''s published API definitions: creatoriq-publishers-openapi.yml, creatoriq-v2-publishers-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://apis.creatoriq.com
description: Live
security:
- apiKey: []
tags:
- name: Publisher
description: Publisher public API
paths:
/crm/v1/api/publisher/{publisherId}:
get:
tags:
- Publisher
summary: Find Publisher by ID
description: Return particular Publisher Information
operationId: getPublisherPublisherId
parameters:
- name: key
in: query
description: 'Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
'
required: false
schema:
type: string
enum:
- Id
- PublisherId
pattern: ^[a-zA-Z0-9]+$
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: ^[a-zA-Z0-9]+$
examples:
- '999999'
examples:
default:
value: '999999'
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- Publisher
Publisher:
$ref: '#/components/schemas/PublisherByIdModel'
required:
- type
- Publisher
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
patch:
tags:
- Publisher
summary: Update Publisher Information
description: Update Publisher Social accounts with verified and linked flags
operationId: patchPublisherPublisherIdAccounts
parameters:
- name: key
in: query
description: 'Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
'
required: false
schema:
type: string
enum:
- Id
- PublisherId
- NetworkPublisherId
pattern: ^[a-zA-Z0-9]+$
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: ^[a-zA-Z0-9]+$
examples:
- '99999'
examples:
default:
value: '99999'
requestBody:
content:
application/json:
schema:
type: object
properties:
PublisherName:
type: string
description: Publisher Name
maxLength: 255
examples:
- test
PublisherId:
type: integer
description: Publisher Id
examples:
- 3293835
NetworkPublisherId:
type:
- string
- 'null'
description: Network Publisher Id
default: null
examples:
- '3293836'
Glasses:
type: integer
enum:
- 0
- 1
- null
description: Glasses
examples:
- 0
AccountManagerName:
type:
- string
- 'null'
description: Account Manager Name
default: null
examples:
- John Smith
OutsideManagerName:
type:
- string
- 'null'
description: Outside Manager Name
default: null
examples:
- John Smith
ManagementCompany:
type:
- string
- 'null'
description: Management Company
default: null
examples:
- John Smith
RecruiterName:
type:
- string
- 'null'
description: Recruiter Name
default: null
examples:
- John Smith
Subnetworks:
type:
- string
- 'null'
description: Subnetworks
default: null
examples:
- Subnetwork1, Subnetwork2, Subnetwork3
Status:
type: string
enum:
- Open
- Active
- New Applicant
- Pending
- Not Accepted
- Applied to Network
- Candidate
- Incomplete
- null
description: Status
examples:
- Open
StatusCategory:
type: string
enum:
- In Network
- In Process
- Other
- null
description: Status Category
examples:
- In Network
CustomValue1:
type:
- string
- 'null'
description: Custom value number 1
maxLength: 1000
default: null
examples:
- test
CustomValue2:
type:
- string
- 'null'
description: Custom value number 2
maxLength: 1000
default: null
examples:
- test
CustomValue3:
type:
- string
- 'null'
description: Custom value number 3
maxLength: 1000
default: null
examples:
- test
CustomValue4:
type:
- string
- 'null'
description: Custom value number 4
maxLength: 1000
default: null
examples:
- test
CustomValue5:
type:
- string
- 'null'
description: Custom value number 5
maxLength: 1000
default: null
examples:
- test
CustomValue6:
type:
- string
- 'null'
description: Custom value number 6
maxLength: 1000
default: null
examples:
- test
CustomValue7:
type:
- string
- 'null'
description: Custom value number 7
maxLength: 1000
default: null
examples:
- test
CustomValue8:
type:
- string
- 'null'
description: Custom value number 8
maxLength: 1000
default: null
examples:
- test
CustomValue9:
type:
- string
- 'null'
description: Custom value number 9
maxLength: 1000
default: null
examples:
- test
CustomValue10:
type:
- string
- 'null'
description: Custom value number 10
maxLength: 1000
default: null
examples:
- test
CustomValue11:
type:
- string
- 'null'
description: Custom value number 11
maxLength: 1000
default: null
examples:
- test
CustomValue12:
type:
- string
- 'null'
description: Custom value number 12
maxLength: 1000
default: null
examples:
- test
CustomValue13:
type:
- string
- 'null'
description: Custom value number 13
maxLength: 1000
default: null
examples:
- test
CustomValue14:
type:
- string
- 'null'
description: Custom value number 14
maxLength: 1000
default: null
examples:
- test
CustomValue15:
type:
- string
- 'null'
description: Custom value number 15
maxLength: 1000
default: null
examples:
- test
CustomValue16:
type:
- string
- 'null'
description: Custom value number 16
maxLength: 1000
default: null
examples:
- test
CustomValue17:
type:
- string
- 'null'
description: Custom value number 17
maxLength: 1000
default: null
examples:
- test
Relationship:
type:
- string
- 'null'
description: Relationship
default: null
examples:
- In a Relationship
Children:
type:
- string
- 'null'
description: Children
default: null
examples:
- One
Pets:
type:
- string
- 'null'
description: Pets
default: null
examples:
- Fish
Tags:
type:
- string
- 'null'
description: Tags
default: null
examples:
- Tag1, Tag2, Tag3
WillTravel:
type: integer
enum:
- 0
- 1
- null
examples:
- 0
BrandsWontWork:
type:
- string
- 'null'
description: Brands Wont Work
default: null
examples:
- Some Brand Name
BrandsWorked:
type:
- string
- 'null'
description: Brands Worked
default: null
examples:
- Some Brand Name
BrandsWishWork:
type:
- string
- 'null'
description: Brands Wish Work
default: null
examples:
- Some Brand Name
EyeColor:
type:
- string
- 'null'
description: Eye Color
default: null
examples:
- Blue
HairColor:
type:
- string
- 'null'
description: Hair Color
default: null
examples:
- Dark
HaveKids:
type: integer
enum:
- 0
- 1
- null
description: Have Kids
examples:
- 0
HavePets:
type: integer
enum:
- 0
- 1
- null
description: Have Pets
examples:
- 0
PhoneNumber:
type:
- string
- 'null'
description: Phone Number
default: null
examples:
- (123)456-7892
HasDriverLicense:
type: integer
enum:
- 0
- 1
- null
description: Has Driver License flag
examples:
- 1
HasPassport:
type: integer
enum:
- 0
- 1
- null
description: Has Passport flag
examples:
- 0
Size:
type:
- string
- 'null'
description: Size
maxLength: 50
default: null
examples:
- Test Size
LeadSource:
type:
- string
- 'null'
description: Lead Source
maxLength: 50
default: null
examples:
- Broad Search
Category:
type:
- string
- 'null'
description: Category
maxLength: 255
default: null
examples:
- Beauty-Hair, Lifestyle
SubCategories:
type:
- string
- 'null'
description: Sub Categories
maxLength: 255
default: null
examples:
- Beauty-General, Beauty-SkinCare
DateOfBirth:
type:
- string
- 'null'
description: Date of Birth
default: null
examples:
- 04/04/1985
PayPalEmail:
type:
- string
- 'null'
description: Email
format: email
default: null
examples:
- test@test.com
PayPalFirstName:
type:
- string
- 'null'
description: First name
default: null
examples:
- Christy
PayPalLastName:
type:
- string
- 'null'
description: First name
default: null
examples:
- Weimann
Address:
type: object
properties:
AddressLine1:
type:
- string
- 'null'
description: Address
examples:
- Robert Robertson, 1234 NW Bobcat Lane, St. Robert
ZIPCode:
type:
- string
- 'null'
description: ZIPCode
examples:
- 02108
City:
type:
- string
- 'null'
description: City
examples:
- Boston
State:
type:
- string
- 'null'
description: State
examples:
- Massachusetts
Country:
type:
- string
- 'null'
description: Country
examples:
- USA
Email:
type:
- string
- 'null'
description: Email
format: email
default: null
examples:
- Estevan.Conn54@yahoo.com
Email1:
type:
- string
- 'null'
description: Email
format: email
default: null
examples:
- test@test.com
Gender:
type: string
description: I.e. Male, Female, Transgender
maxLength: 50
examples:
- Female
FirstName:
type: string
description: First name
examples:
- Christy
LastName:
type: string
description: First name
examples:
- Weimann
FullName:
type: string
description: First name
examples:
- Christy Weimann
EthnicBackground:
type:
- string
- 'null'
description: I.e. Asian, Caucasian, African American
maxLength: 255
default: null
examples:
- Asian
Language:
type: string
description: Publisher's primary language. I.E. English. If this field is left blank and YouTube channel is specified SocialEdge will attempt to look this up via YouTube API
maxLength: 50
examples:
- English
Language2:
type: string
description: Publisher's language. I.E. English. If this field is left blank and YouTube channel is specified SocialEdge will attempt to look this up via YouTube API
maxLength: 50
examples:
- English
DatePublisherDeActivated:
type: string
description: Date published when activated
format: date-time
examples:
- '2021-01-30T08:30:00Z'
Description:
type:
- string
- 'null'
description: If this field is left blank and YouTube channel is specified SocialEdge will attempt to look up YouTube channel description via YouTube API and use it as default value
default: null
examples:
- My channel description
accountId:
type: string
description: SocialNetworkId for account
examples:
- '999999999999999999'
network:
type: string
enum:
- Youtube
- Twitter
- Facebook
- Instagram
- Google
- Vine
description: Social network (Twitter, Facebook, Instagram, Google, Vine etc.)
examples:
- Youtube
CreatedBy:
type: string
description: Name of person who added Social Account
examples:
- Admin
CreatorRole:
type: string
description: Role of person who added Social Account
examples:
- Admin
VerifiedBy:
type: string
description: Name of person who verified Social Account
examples:
- Admin
VerifiedAt:
type: string
description: Date and Time when Social Account was verified (e.g. 2015-06-04 10:00:01.000)
format: date-time
examples:
- '2015-06-04 10:00:01.000'
LinkedBy:
type: string
description: Name of person who linked Social Account
examples:
- Admin
LinkedAt:
type: string
description: Date and Time when Social Account was linked (e.g. 2015-06-04 10:00:01.000)
format: date-time
examples:
- '2015-06-04 10:00:01.000'
minProperties: 1
responses:
'204':
description: Successful
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
delete:
tags:
- Publisher
summary: Delete Publisher from Network
description: Delete publisher form network
operationId: deletePublisher
parameters:
- name: key
in: query
description: 'Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
'
required: false
schema:
type: string
enum:
- Id
- PublisherId
pattern: ^[a-zA-Z0-9]+$
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: ^[a-zA-Z0-9]+$
examples:
- '9999'
examples:
default:
value: '9999'
responses:
'204':
description: Successful
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/publisher/{publisherId}/scheduledPosts:
get:
tags:
- Publisher
summary: Get Publisher ScheduledPosts info
description: Get Publisher ScheduledPosts
operationId: getPublisherIdScheduledPosts
parameters:
- name: key
in: query
description: 'Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
'
required: false
schema:
type: string
enum:
- Id
- PublisherId
pattern: ^[a-zA-Z0-9]+$
examples:
- Id
examples:
default:
value: Id
- name: page
in: query
description: page number
schema:
type: string
examples:
- '2'
examples:
default:
value: '2'
- name: size
in: query
description: number of elements on page
schema:
type: string
examples:
- '20'
examples:
default:
value: '20'
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
examples:
- '20'
examples:
default:
value: '20'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignScheduledPostsSuccessResponseModel'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/publishers/{publisherIds}/accounts:
get:
tags:
- Publisher
summary: GET social accounts for multiple publishers.
description: 'Fetch the social accounts information for bulk publishers. Max count of publishers 10.
> **Warning**: This API endpoint is deprecated and will be removed at 2026-04-16. You could use the [new version of endpoint](https://apidocs.creatoriq.com/docs/ciq-api-documentation/5d20075e89450-get-social-accounts-for-multiple-publishers) instead of this one.
'
operationId: getMultiplePublishersAccounts
parameters:
- name: publisherIds
in: path
description: Comma separated unique Publisher IDs.
required: true
schema:
type: string
pattern: ^[0-9]+(,[0-9]+)*$
examples:
- 99990,99991
examples:
default:
value: 99990,99991
responses:
'200':
description: Response 200
content:
application/json:
schema:
$ref: '#/components/schemas/MultiplePublishersAccounts'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
deprecated: true
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/publisher/{publisherId}/accounts:
get:
tags:
- Publisher
summary: GET publisher's social accounts
description: Fetch the social account information for publisher
operationId: getPublisherAccounts
parameters:
- name: key
in: query
description: 'Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
'
required: true
schema:
type: string
enum:
- Id
- PublisherId
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher's ID
required: true
schema:
type: string
pattern: ^[0-9]+$
examples:
- '9999'
examples:
default:
value: '9999'
responses:
'200':
description: Response 200
content:
application/json:
schema:
type: object
description: Publisher Accounts Collection
properties:
type:
type: string
description: Type of Search
examples:
- AccountCollection
href:
type: string
description: href
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/99999999999
AccountCollection:
type: array
items:
$ref: '#/components/schemas/SocialAccountModel'
required:
- type
- href
- AccountCollection
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
post:
tags:
- Publisher
summary: Add Publisher Social accounts information
description: Add Publisher Social accounts information
operationId: addPublisherSocialAccount
parameters:
- name: source
in: query
description: Type of input data ('link' or 'user')
required: true
schema:
type: string
enum:
- link
- user
examples:
- link
examples:
default:
value: link
- name: accountSource
in: query
description: Account source
required: false
schema:
type: string
examples:
- crm
examples:
default:
value: crm
- name: key
in: query
description: 'Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
'
required: false
schema:
type: string
enum:
- Id
- PublisherId
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: ^[0-9]+$
examples:
- '99999'
examples:
default:
value: '99999'
requestBody:
content:
application/json:
schema:
type: object
properties:
link:
type: string
description: Link to social account
format: URI
examples:
- https://www.youtube.com/@username
user:
type: string
description: 'Username in social network. Available chars are:
- Capital and small letters (latin)
- Point `.`
- Minus `-`
- Underscore `_`
- "AT" char `@`
'
pattern: ^[\w.\-_@]+$
examples:
- user_name
network:
type: string
enum:
- Youtube
- Facebook
- Instagram
- Google
- Vine
- Tumblr
description: Social network (Facebook, Instagram, Google, Vine, Tumblr etc.)
examples:
- Youtube
CreatedBy:
type: string
description: Name of person who added Social Account
examples:
- John Smith
CreatorRole:
type: string
description: Role of person who added Social Account
examples:
- Admin
VerifiedBy:
type: string
description: Name of person who verified Social Account
examples:
- John Smith
VerifiedAt:
type: string
description: Date and Time when Social Account was verified (e.g. 2015-06-04 10:00:01.000)
format: date-time
examples:
- '2021-01-30T08:30:00Z'
LinkedBy:
type: string
description: Name of person who linked Social Account
examples:
- John Smith
LinkedAt:
type: string
description: Date and Time when Social Account was linked (e.g. 2015-06-04 10:00:01.000)
format: date-time
examples:
- '2015-06-04 10:00:01.000'
WhitelistingExpirationDate:
type: string
description: Date and Time when whitelisting token was expired
format: date-time
examples:
- '2015-06-04 10:00:01.000'
required:
- user
- network
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- Publisher
Social:
type: object
properties:
PublisherId:
type: string
description: Publisher ID
examples:
- '99999'
Network:
type: string
description: Social network name (Facebook, Instagram etc.)
examples:
- Instagram
Type:
type: string
description: Account type for Facebook network
examples:
- Account type
SocialNetworkId:
type: string
description: Id in social network
examples:
- '9999'
NetworkUser:
type: string
description: User name in social network
examples:
- Jon
Followers:
type: string
description: Followers count
examples:
- '9999'
SocialStats:
type: array
description: Social stats array
items:
type: object
DateSocialStatsUpdated:
type: string
description: Timestamp of the most recent successful run of the social-statistics refresh job for this account (follower count, post count, engagement aggregates). Driven by a different background job from `LastUpdated` and `EngagementCalculated`, so the three can legitimately differ for the same account — some divergence between these timestamps is expected and does not indicate stale data.
examples:
- '2015-06-04 10:00:01.000'
LastUpdated:
type: string
description: Timestamp of the most recent change to any field on this social account record by any background job. Independent of `DateSocialStatsUpdated` and `EngagementCalculated`, which track specific ETL jobs — these three timestamps can legitimately differ for the same account.
examples:
- '2015-06-04 10:00:01.000'
UpdatedBy:
type: string
description: User updated the record
examples:
- Jon
NotFound:
type: string
description: If true then account is "Not found" anymore
examples:
- Not found
Protected:
type: string
description: Is account protected
examples:
- 'true'
CPP:
type: number
description: Channel CPP
examples:
- 9999
CPE:
type: number
description: Channel CPE
examples:
- 9999
CPM:
type: number
description: Channel CPM
examples:
- 9999
required:
- PublisherId
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
patch:
tags:
- Publisher
summary: Update Publisher Social accounts information
description: 'Update Publisher Social accounts information
Social network (Facebook, Instagram, Google, Vine, Tumblr etc.)
'
operationId: updatePublisherSocialAccounts
parameters:
- name: key
in: query
description: An additional parameter that should be used if you use `Id` instead of `PublisherId`.
required: false
schema:
type: string
examples:
- id
examples:
default:
value: id
- name: publisherId
in: path
description: Unique Publisher identifier, `PublisherId` from Get all Publishers endpoint
required: true
schema:
type: string
pattern: ^[0-9]+$
examples:
- '99999'
examples:
default:
value: '99999'
requestBody:
content:
application/json:
schema:
type: object
properties:
accountId:
type: string
description: 'Account ID in social network.
This `Id` can be obtained from [Get publisher''s social accounts API](https://creatoriq.stoplight.io/docs/ciq-api-documentation/53138e18cb0a8-get-publisher-s-social-accounts) endpoint, the field is called `SocialNetworkId`
'
examples:
- '3454778729'
network:
type: string
enum:
- youtube
- facebook
- instagram
- google
- vine
- tumblr
description: Social network (Facebook, Instagram, Google, Vine, Tumblr etc.)
examples:
- instagram
AQH:
type: number
format: float
examples:
- 0.327
max: 1
min: 0
Cume:
type: integer
examples:
- 234
min: 0
AvgWeeklyUniqueUsers:
type: integer
format: int64
examples:
- 10000000000000000000
min: 0
Followers:
type: integer
format: int64
examples:
- 10000000000000000000
min: 0
required:
- accountId
- network
responses:
'204':
description: Account updated
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
delete:
tags:
- Publisher
summary: Delete Publisher Social accounts
description: Removes a social account from a creator.
operationId: deletePublisherPublisherIdAccounts
parameters:
- name: key
in: query
description: 'Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
'
required: false
schema:
type: string
enum:
- Id
- PublisherId
pattern: ^[a-zA-Z0-9]+$
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: ^[a-zA-Z0-9]+$
examples:
- '9999'
examples:
default:
value: '9999'
requestBody:
content:
application/json:
schema:
type: object
properties:
accountId:
type: string
description: SocialNetworkId for account
examples:
- '999999999999999999'
network:
type: string
description: Network name
examples:
- tiktok
responses:
'204':
description: Successful
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/data/contact/{contactId}:
get:
tags:
- Publisher
summary: Get Contact Data
description: Returns a single contact from a publisher (creator).
operationId: getContactData
parameters:
- name: contactId
in: path
description: Unique Contact identifier
required: true
schema:
type: integer
examples:
- 12444
examples:
default:
value: 12444
responses:
'200':
description: Response 200
content:
application/json:
schema:
type: object
properties:
type:
const: Address
description: Type of Search
examples:
- Address
href:
type: string
description: href
examples:
- https://apis.creatoriq.com/crm/v1/api/data/contact/9999999999
Address:
type: object
properties:
Id:
type: integer
description: Unique contact Id
examples:
- 13326640
FirstName:
type: string
description: First name
examples:
- Christy
LastName:
type: string
description: Last name
examples:
- Weimann
FullName:
type: string
description: Full name
examples:
- Christy Weimann
AddressLine1:
type:
- string
- 'null'
description: Part of address field
default: null
examples:
- Robert Robertson, 1234 NW Bobcat Lane, St. Robert
AddressLine2:
type:
- string
- 'null'
description: Part of address field
default: null
examples:
- Robert Robertson, 1234 NW Bobcat Lane, St. Robert
ZIPCode:
type: string
description: ZIPCode
examples:
- 02108
City:
type:
- string
- 'null'
default: null
examples:
- Boston
State:
type:
- string
- 'null'
default: null
examples:
- Massachusetts
Country:
type:
- string
- 'null'
description: Name of country
default: null
examples:
- USA
Email:
type:
- string
- 'null'
description: Part of contact info
default: null
examples:
- Estevan.Conn54@yahoo.com
Email1:
type:
- string
- 'null'
description: Part of contact info
default: null
examples:
- Robb82@gmail.com
PhoneNumber:
type:
- string
- 'null'
description: Phone number
default: null
examples:
- (555) 555-1234
PublisherId:
type: integer
description: Unique publisherId
format: int32
examples:
- 12334
PrimaryContact:
type: integer
enum:
- 0
- 1
description: Primary contact flag
examples:
- 0
EmailExists:
type: boolean
description: Flag if email exists
examples:
- false
Complaint:
type:
- boolean
- 'null'
description: Email Complaint Flag
default: null
examples:
- false
required:
- type
- href
- Address
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
patch:
tags:
- Publisher
summary: Edit publisher contact data
description: Makes updates to a publisher contact.
operationId: PATCHContactData
parameters:
- name: contactId
in: path
description: Unique Contact identifier
required: true
style: simple
schema:
type: integer
examples:
- 117929027
examples:
default:
value: 117929027
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PATCHContactDataRequest'
responses:
'204':
description: Success
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/ErrorResponse404PATCHContactData'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
delete:
tags:
- Publisher
summary: Delete a Publisher Contact
description: Delete a Publisher Contact
operationId: deletePublisherContact
parameters:
- name: contactId
in: path
description: Unique Contact identifier
required: true
style: simple
schema:
type: integer
examples:
- 117929027
examples:
default:
value: 117929027
responses:
'204':
description: Successful
'400':
$ref: '#/components/responses/400DeleteContactData'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/ErrorResponse404PATCHContactData'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/data/contact:
post:
tags:
- Publisher
summary: Create publisher contact data
description: Create a new publisher contact.
operationId: POSTContactData
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/POSTContactDataRequest'
responses:
'201':
$ref: '#/components/responses/POSTContactResponse'
'400':
$ref: '#/components/responses/POSTContactResponse400'
'403':
$ref: '#/components/responses/403'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/publisher/{publisherId}/log:
get:
tags:
- Publisher
summary: Get Publisher Log
description: Returns the action history for a single publisher (creator)
operationId: getPublisherLogs
parameters:
- name: key
in: query
description: Optional, search key field. NetworkPublisherId used by default
required: false
schema:
type: string
default: NetworkPublisherId
examples:
- NetworkPublisherId
examples:
default:
value: NetworkPublisherId
- name: page
in: query
description: Page to go
schema:
type: integer
format: int32
default: 1
examples:
- 1
examples:
default:
value: 1
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
examples:
- '9999'
examples:
default:
value: '9999'
responses:
'200':
description: Response 200
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- Publisher
page:
type: integer
description: Current page
examples:
- 1
total:
type: integer
description: Total number of found rows
examples:
- 1
count:
type: integer
description: Number of records in current response
examples:
- 100
EventLogCollection:
type: array
items:
$ref: '#/components/schemas/EventLogCollection'
required:
- page
- total
- count
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/publisher/{publisherId}/audience:
get:
tags:
- Publisher
summary: Get Publisher Audience
description: "Returns any first-party audience data for a specific publisher (creator).\n\nPlease note that the response may contain one of the following options:\n* an object with data (if there is a publisher and there is an audience data) \n* an empty array (if there is a publisher, but we do not have an audience of data)\n"
operationId: getPublisherAudience
parameters:
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: ^[a-zA-Z0-9]+$
examples:
- '9999'
examples:
default:
value: '9999'
responses:
'200':
description: Response 200
content:
application/json:
schema:
type: object
description: Publisher Audience Response
properties:
type:
const: Audience
description: Type of Search
examples:
- Audience
href:
type: string
description: href
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/3293835/audience
Audience:
type: object
oneOf:
- $ref: '#/components/schemas/Audience'
- $ref: '#/components/schemas/AudienceEmpty'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/statuses:
get:
tags:
- Publisher
summary: Get all available Publishers statuses
description: Get all available publisher statuses that the 'Status' field can return
operationId: getAllAvailablePublishersStatuses
responses:
'200':
description: Response 200
content:
application/json:
schema:
type: object
properties:
type:
type: string
examples:
- Statuses
Statuses:
type: object
properties:
Open:
type: array
examples:
- - In process
items:
type: string
Suspended:
type: array
examples:
- - Inactive (Other Network)
items:
type: string
Rejected:
type: array
examples:
- - AdSense issues
items:
type: string
Active:
type: array
examples:
- - In Network
items:
type: string
Lost:
type: array
examples:
- - In Network
items:
type: string
Signed:
type: array
examples:
- - AdSense issues
items:
type: string
Approved:
type: array
examples:
- - Waiting for signed contract
items:
type: string
Incomplete:
type: array
examples:
- - Onboarding incomplete
items:
type: string
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/publishers:
get:
tags:
- Publisher
summary: Get all Publishers
description: Returns the list of publishers (creators).
operationId: getAllPublishers
parameters:
- name: size
in: query
description: Limit the result set. Default is 20.
required: false
schema:
type: integer
maximum: 1000
examples:
- 1
examples:
default:
value: 1
- name: page
in: query
description: Page number in the result set
required: false
schema:
type: integer
examples:
- 1
examples:
default:
value: 1
- name: filter
in: query
description: 'Filter for records. Can be a set of filters: Column1=Value1,Value2;Column2=Value3
E.g., Status=Active;Gender=female
The list of the fields that can be used for filtering:
- Id
- PublisherName
- NetworkPublisherId
- DateOfBirth
- Language
- EthnicBackground
- Gender
- RecruiterName
- Category
- SubCategories
- Description
- LastUpdated
- Country
- Relationship
- Children
- Pets
- EyeColor
- HairColor
- InternalDescription
- Tags
- TotalSubscribers
'
required: false
schema:
type: string
examples:
- Column1=Value1
examples:
default:
value: Column1=Value1
- name: order
in: query
description: 'Order records. Can be specified as Column,direction I.e. PublisherName,asc.
You can omit the direction by providing only Column i.e. PublisherName, in such case it will equal to PublisherName,asc.
The list of available values for sorting:
- PublisherName
- TotalSubscribers
- DateRecruitingStarted
'
required: false
schema:
type: string
examples:
- PublisherName,asc
examples:
default:
value: PublisherName,asc
- name: fields
in: query
description: fields
schema:
type: string
examples:
- Id
examples:
default:
value: Id
responses:
'200':
description: Response 200
content:
application/json:
schema:
type: object
properties:
type:
const: PublisherCollection
examples:
- PublisherCollection
page:
type: integer
description: Current page
examples:
- 2
total:
type: integer
description: Total number of found rows
examples:
- 200
count:
type: integer
description: Number of records in current response
examples:
- 20
PublisherCollection:
type: array
items:
$ref: '#/components/schemas/PublisherModel'
required:
- page
- total
- count
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
post:
tags:
- Publisher
summary: Create publisher
description: 'Create publisher in network. You should pass **PublisherName** or **accounts** field for creating publisher.
'
operationId: createPublisher
requestBody:
content:
application/json:
schema:
type: object
description: Required PublisherName or accounts fields
properties:
PublisherFirstName:
type: string
examples:
- therock
PublisherName:
type: string
description: Publisher Name field is required when accounts field is not present
examples:
- therock
RecruiterName:
type: string
examples:
- Admin
LogoURL:
type: string
format: URI
examples:
- https://avatar.jpg
LogoHighResURL:
type: string
format: URI
examples:
- https://highreslogoUrl.png
FlagshipProperty:
type: string
description: Main social account name
examples:
- therock
FlagshipSocialNetwork:
type: string
description: Main social network
examples:
- instagram
PublisherLastName:
type: string
examples:
- Last Name
Language:
type: string
examples:
- English
Tags:
type:
- string
- 'null'
description: Tags
default: null
examples:
- Tag1, Tag2, Tag3
DateOfBirth:
type: string
examples:
- Jan 8, 1987
EthnicBackground:
type: string
examples:
- white
Address:
type: object
description: Address fields
properties:
Country:
type: string
examples:
- Albania
accounts:
type: array
description: List of attached accounts
items:
type: object
properties:
id:
type: string
description: Social network username. In the case of YouTube, this should be a unique channel Id
examples:
- therock
network:
type: string
description: Network of social account
examples:
- Instagram
required:
- id
- network
minProperties: 1
responses:
'201':
$ref: '#/components/responses/createPublisherResponse200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/reports/PublishersDataChanges:
get:
tags:
- Publisher
summary: Get all Publishers accounts changes
description: Get all Publishers accounts changes
operationId: getAllPublishersAccountsChanges
parameters:
- name: limit
in: query
description: Limit the result set.
required: false
schema:
type: integer
examples:
- 1
examples:
default:
value: 1
- name: offset
in: query
description: Offset the result set.
required: false
schema:
type: integer
examples:
- 1
examples:
default:
value: 1
- name: DateRangeStart
in: query
description: Date range start.
required: false
schema:
type: string
examples:
- '2023-01-03'
examples:
default:
value: '2023-01-03'
- name: DateRangeEnd
in: query
description: Date range end.
required: false
schema:
type: string
examples:
- '2023-01-03'
examples:
default:
value: '2023-01-03'
responses:
'200':
description: Response 200
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- AccountCollection
href:
type: string
description: href
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/99999999999/accounts?key=Id
count:
type: number
description: count
examples:
- 1
total:
type: number
description: total
examples:
- 1
page:
type: number
description: page
examples:
- 1
EventLog:
type: array
items:
$ref: '#/components/schemas/PublisherDataChangesCollectionEventLog'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/communication/send:
post:
tags:
- Publisher
summary: Send a message to publisher
description: Send a message to publisher
operationId: sendMessageToPublisher
requestBody:
content:
application/json:
schema:
type: object
properties:
Subject:
type: string
description: Subject
examples:
- Subject
MessageContent:
type: string
description: Message content
examples:
- Message
ToId:
type: string
description: Id publisher
examples:
- '9999999'
type:
type: object
description: Type object
properties:
Email:
type: string
description: Email
examples:
- email@gmail.com
Message:
type: string
description: Message
examples:
- Message
responses:
'204':
description: Successful
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/publisher/{publisherId}/campaigns:
get:
tags:
- Publisher
summary: Get Campaigns assigned to Publisher
description: Returns a list of campaign objects for all the campaigns a specific publisher (creator) is associated with
operationId: getCampaignsAssignedToPublisher
parameters:
- name: key
in: query
description: 'Specifies which identifier the `publisherId` path value is matched against.
Defaults to the internal `Id` when omitted (equivalent to `key=Id`).
Set to `PublisherId` to match by the network `PublisherId` returned by the Get all Publishers endpoint.
'
required: false
schema:
type: string
enum:
- Id
- PublisherId
pattern: ^[a-zA-Z0-9]+$
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: ^[a-zA-Z0-9]+$
examples:
- '9999'
examples:
default:
value: '9999'
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- CampaignCollection
page:
type: integer
description: Current page
examples:
- 1
total:
type: integer
description: Total number of found rows
examples:
- 1
count:
type: integer
description: Number of records in current response
examples:
- 1
total_pages:
type: integer
description: Total number of pages
examples:
- 1
CampaignCollection:
type: array
items:
$ref: '#/components/schemas/CampaignInformationSuccessResponseModel'
required:
- page
- total
- count
- CampaignCollection
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/communication/CampaignMessaging:
post:
tags:
- Publisher
summary: Send a message to publisher (regarding to particular campaign)
description: Send a message to publisher (regarding to particular campaign)
operationId: sendMessageToPublisherRegardingToParticularCampaign)
requestBody:
content:
application/json:
schema:
type: object
properties:
CCToCurrent:
type: integer
description: CC
format: int32
examples:
- 99999
Date:
type: string
description: Date
examples:
- '2020-02-29'
FromMcn:
type: integer
description: From Mcn
format: int32
examples:
- 99999
MessageContent:
type: string
description: Message content
examples:
- Message
Subject:
type: string
description: Subject
examples:
- Subject
messageId:
type: string
description: Message Id
examples:
- '9999'
ToCC:
type: string
description: To CC
examples:
- ToCC
type:
type: object
properties:
Email:
type: integer
description: Email flag
format: int32
examples:
- 1
Message:
type: integer
description: Message flag
format: int32
examples:
- 1
ToPublishers:
type: array
items:
type: integer
description: Publishers Ids
format: int32
examples:
- 999999
CampaignId:
type: integer
description: Campaign Id
format: int32
examples:
- 999999
AttachmentsLinks:
type: array
examples:
- - https://google.com
items:
type: string
description: Attachment Links
examples:
- https://google.com
publisherId:
type: array
items:
type: integer
description: Publishers Ids
format: int32
examples:
- 999999
ShowBodyInChat:
type: integer
description: Show body in chat
format: int32
examples:
- 1
Event:
type: string
description: Event name
examples:
- Event
required:
- FromMcn
- MessageContent
- CampaignId
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
Message:
type: string
description: Message string
examples:
- Message
UserName:
type: string
description: User name
examples:
- Jon
ToPublisherIds:
type: array
items:
type: integer
description: Publisher Id
format: int32
examples:
- 99999
'400':
description: Bad request, invalid PublisherID format
'401':
description: The request could not be completed due to invalid API credentials
'403':
description: Access was denied due to the API due to insufficient access permissions.
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/communication/sendBulk:
post:
tags:
- Publisher
summary: Send emails to publishers in bulk.
description: Send emails to publishers in bulk.
operationId: sendMessageToPublishersBulk
requestBody:
content:
application/json:
schema:
type: object
properties:
CCToCurrent:
type: integer
enum:
- 0
- 1
description: "CCToCurrent is a flag that indicates whether a copy of the message should be sent to \nthe sender (author) of the message. Setting the \"CCToCurrent\" flag = 1 means that a copy will be \nsent to the author of the letter.\n"
format: int32
examples:
- 1
Date:
type: string
description: Message sent date
examples:
- '2020-02-29'
FromMcn:
type: integer
description: This is the ID of the current user logged into the CRM or the ID of the user on whose behalf the API key is being used.
format: int32
examples:
- 100013349
MessageContent:
type: string
description: Message content. Can include a Cpp Link placeholder - Client (Creator) Payment Processing link. See example
examples:
- 'Test CppLink: {{CppLink}}'
Subject:
type: string
description: Subject
examples:
- Subject
messageId:
type: string
description: Message Id
examples:
- '9999'
ToCC:
type: string
description: "ToCC - is analog of the carbon copy of standard email protocol. Cc stands for carbon copy\nwhich means that whose address appears after the Cc header would receive a copy of the message. \nAlso, the Cc header would also appear inside the header of the received message.\n"
examples:
- email1@gmail.com, email2@gmail.com
type:
type: object
description: Message type. Can be "Email" (email send) or/and "Message" (internal only in CRM send)
properties:
Email:
type: integer
enum:
- 0
- 1
description: "If the \"Email\" flag = 1, this means that the message type is set as \"Email\" and will \nbe sent as an email. If the \"Email\" flag = 0, the message will not be sent as an email.\nThe \"Email\" and \"Message\" flags can be used together. For example, \"Email = 0\", \n\"Message = 1\" - means that only an internal message within the CRM will be sent.\n"
format: int32
examples:
- 1
Message:
type: integer
enum:
- 0
- 1
description: "If the \"Message\" flag = 1, this means that the type of message being sent is set as \n\"Message\" and will be sent as an internal message in the CRM with saving to the dbo.Messages \ndatabase table. The Message flag = 0 means that the internal message within the CRM will not \nbe sent. The \"Email\" and \"Message\" types can be used together.\nFor example, \"Email = 1\", \"Message = 1\" - means that both an email and an internal \nmessage in the CRM will be sent.\n"
format: int32
examples:
- 1
ToPublishers:
type: array
items:
type: integer
description: Publishers Ids. Can contain no more than 1,000 different IDs.
format: int32
examples:
- 999999
AttachmentsLinks:
type: array
description: "This is an array of objects for sending preloaded attachments to the letter. \nTo use them, you need to have a response from the AWS Bitbucket responsible for uploading files.\n"
examples:
- - FileName: Screenshot 2023-05-03 at 12.51.19.png
AttachmentLink: https://twc-attachments.s3.us-west-1.amazonaws.com/599407372_Screenshot%202023-05-03%20at%2012.51.19.png
AttachmentThumbnail: https://twc-attachments.s3.us-west-1.amazonaws.com/thumbnails/thumb_57fcda4899162340996cbf6ab4ed25ca_8403080.png
ContentSize: 38721
items:
type: object
description: 'This is object for sending preloaded attachments to the letter.
To use them, you need to have a response from the AWS Bitbucket responsible for uploading files.
'
properties:
FileName:
type: string
description: Attachment File Name
examples:
- Screenshot 2023-05-03 at 12.51.19.png
AttachmentLink:
type: string
description: Attachment Link
format: URI
examples:
- https://twc-attachments.s3.us-west-1.amazonaws.com/599407372_Screenshot%202023-05-03%20at%2012.51.19.png
AttachmentThumbnail:
type: string
description: Attachment Thumbnail url
format: URI
examples:
- https://twc-attachments.s3.us-west-1.amazonaws.com/thumbnails/thumb_57fcda4899162340996cbf6ab4ed25ca_8403080.png
ContentSize:
type: integer
description: Size of attachment in bytes
format: int32
examples:
- 38721
examples:
- FileName: Screenshot 2023-05-03 at 12.51.19.png
AttachmentLink: https://twc-attachments.s3.us-west-1.amazonaws.com/599407372_Screenshot%202023-05-03%20at%2012.51.19.png
AttachmentThumbnail: https://twc-attachments.s3.us-west-1.amazonaws.com/thumbnails/thumb_57fcda4899162340996cbf6ab4ed25ca_8403080.png
ContentSize: 38721
ShowBodyInChat:
type: integer
enum:
- 0
- 1
description: Show body in chat flag - Is show a body of a message in a chat with a creator?
format: int32
examples:
- 1
Event:
type: string
description: 'This is an internal CRM field for processing the logic of different types of messages and events. To send emails and/or internal messages for the CRM, it is recommended to set "Event": "sendMessage"'
examples:
- Event
required:
- MessageContent
- Subject
- type
- ToPublishers
responses:
'204':
description: Successful
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/publisher/{publisherId}/{property}:
get:
tags:
- Publisher
summary: Get Publisher property details
description: Get Publisher property details
operationId: getPublisherPublisherIdProperty
parameters:
- name: key
in: query
description: 'Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
'
required: true
schema:
type: string
enum:
- Id
- PublisherId
default: PublisherId
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: ^[0-9]+$
examples:
- '12840667'
examples:
default:
value: '12840667'
- name: property
in: path
description: 'channels: Get Publisher Channels information;
accounts: Get Publisher Social accounts information.
'
required: true
schema:
type: string
enum:
- channels
- accounts
- campaigns
- messages
- summary
- contacts
examples:
- accounts
examples:
default:
value: accounts
responses:
'200':
description: Successful
content:
application/json:
schema:
oneOf:
- type: object
description: Publisher Channels information
properties:
href:
type: string
description: CreatorIQ API URL to get publisher’s channels
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/99999999/channels?key=Id
type:
type: string
description: Type of Search
examples:
- Publisher
page:
type: integer
description: Current page
examples:
- 1
total:
type: integer
description: Total number of found rows
examples:
- 1
count:
type: integer
description: Number of records in current response
examples:
- 1
ChannelCollection:
type: array
description: List of channels
items:
$ref: '#/components/schemas/channelItem'
required:
- href
- type
- ChannelCollection
- type: object
description: Publisher Social accounts information
properties:
href:
type: string
description: CreatorIQ API URL to get publisher’s social accounts
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/10001776608/channels?key=Id
type:
type: string
description: Type of Search
examples:
- Publisher
page:
type: integer
description: Current page
examples:
- 1
total:
type: integer
description: Total number of found rows
examples:
- 1
count:
type: integer
description: Number of records in current response
examples:
- 1
AccountCollection:
type: object
properties:
Channel:
type: object
properties:
type:
type: string
description: Type account (Channel,Social...)
examples:
- Channel
Channel:
$ref: '#/components/schemas/Channel'
Account:
type: object
properties:
type:
type: string
description: Type account (Channel,Social...)
examples:
- Channel
Social:
$ref: '#/components/schemas/Social'
required:
- href
- type
- AccountCollection
- type: object
description: Publisher campaigns
properties:
href:
type: string
description: CreatorIQ API URL to get publisher’s campaigns
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/999999999/campaigns?order=EndDate%2CDESC&key=Id
type:
const: CampaignCollection
description: Type of Search
examples:
- CampaignCollection
page:
type: integer
description: Current page
examples:
- 1
total:
type: integer
description: Total number of found rows
examples:
- 1
count:
type: integer
description: Number of records in current response
examples:
- 1
CampaignCollection:
type: array
items:
$ref: '#/components/schemas/CampaignModel'
required:
- href
- type
- CampaignCollection
- type: object
description: Publisher messages
properties:
href:
type: string
description: CreatorIQ API URL to get publisher’s messages
examples:
- https://apis.creatoriq.com/crm/v1/api/message/999999
type:
const: Message
description: Type of Search
examples:
- Message
Message:
type: object
required:
- href
- type
- Message
- type: object
description: Publisher summary
properties:
href:
type: string
description: CreatorIQ API URL to get publisher’s summary
examples:
- https://apis.creatoriq.com/crm/v1/api/summary?key=Id
type:
const: Summary
description: Type of Search
examples:
- Summary
Summary:
$ref: '#/components/schemas/Summary'
required:
- href
- type
- Summary
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/publishers/tags:
post:
tags:
- Publisher
summary: Add tags to publishers
description: Add tags to publisher without rewriting previous tags
operationId: addPublishersTags
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/tagSchema'
responses:
'204':
description: Successful
'400':
description: Ids not specified
'404':
description: Publisher with supplied ID was not found
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
delete:
tags:
- Publisher
summary: Remove tags from publishers
description: Remove tags from publishers
operationId: deletePublishersTags
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/tagSchema'
responses:
'204':
description: Successful
'400':
description: Ids not specified
'404':
description: Publisher with supplied ID was not found
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/publisher/{publisherId}/updateAccounts:
patch:
tags:
- Publisher
summary: Trigger an update for a particular Publisher's social account
description: Update a social account info
operationId: updatePublisherSocialAccount
parameters:
- name: key
in: query
description: 'Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
'
schema:
type: string
enum:
- Id
- PublisherId
default: PublisherId
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Publisher ID
required: true
schema:
type: integer
examples:
- 852467724
examples:
default:
value: 852467724
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/updatePublisherSocialAccountBody'
responses:
'200':
$ref: '#/components/responses/updatePublisherSocialAccountResponse'
'204':
description: No account to update
'400':
description: publisherId not specified
'404':
description: Publisher with supplied ID was not found
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v1/api/data/publisher/{publisherId}/audience:
patch:
tags:
- Publisher
summary: Add/Update the audience data for a publisher.
description: "Edit or add audience data to the publisher's social account. To be able to use this API, you need required fields that can be derived from [Get publisher's social accounts API](https://creatoriq.stoplight.io/docs/ciq-api-documentation/53138e18cb0a8-get-publisher-s-social-accounts).\n\n 1. Fetch list of social accounts from [Get publisher's social accounts API](https://creatoriq.stoplight.io/docs/ciq-api-documentation/53138e18cb0a8-get-publisher-s-social-accounts) for the publisher.\n 2. From the `AccountCollection` property, get the following for the social network you intend to add/edit audience data:\n - SocialId (use value of `ChannelId` for Youtube Account or `Id` field for any other Social Account)\n - Network\n - SocialNetworkId\n - NetworkUser \n 3. Fill in these required fields when calling this API.\n"
operationId: manualAudienceAddEdit
parameters:
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: integer
examples:
- 12344
examples:
default:
value: 12344
requestBody:
content:
application/json:
schema:
type: object
properties:
SocialId:
type: integer
description: 'SocialAccountId for account. Can be fetched by [GET publisher''s social accounts](https://creatoriq.stoplight.io/docs/ciq-api-documentation/53138e18cb0a8-get-publisher-s-social-accounts):
`AccountCollection->Social->Id` (`AccountCollection->Channel->ChannelId` for YouTube account) property
'
examples:
- 25485805
Network:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
description: Type of network of social account
maxLength: 50
examples:
- instagram
NetworkUser:
type: string
description: Name of account in social network
maxLength: 50
examples:
- marcelotwelve
SocialNetworkId:
type: string
description: Id of account in Social Network
examples:
- '176702683'
MalePercentage:
type: number
examples:
- 23.3
FemalePercentage:
type: number
examples:
- 45.3
AgeGroup1:
type: string
examples:
- 13-17
AgeGroup2:
type: string
examples:
- 18-24
AgeGroup3:
type: string
examples:
- 25-34
AgeGroup4:
type: string
examples:
- 35-44
AgeGroup5:
type: string
examples:
- 45-54
AgeGroup6:
type: string
examples:
- 55-64
AgeGroup7:
type: string
examples:
- 65-
AgePercentage1:
type: number
examples:
- 23.2
AgePercentage2:
type: number
examples:
- 23.2
AgePercentage3:
type: number
examples:
- 23.2
AgePercentage4:
type: number
examples:
- 23.2
AgePercentage5:
type: number
examples:
- 23.2
AgePercentage6:
type: number
examples:
- 23.2
AgePercentage7:
type: number
examples:
- 23.2
EthnicityPercentage1:
type:
- number
- 'null'
examples:
- 22.3
Ethnicity1:
type:
- string
- 'null'
maxLength: 50
examples:
- Caucasian
EthnicityPercentage2:
type:
- number
- 'null'
examples:
- 22.3
Ethnicity2:
type:
- string
- 'null'
maxLength: 50
examples:
- Caucasian
EthnicityPercentage3:
type:
- number
- 'null'
examples:
- 22.3
Ethnicity3:
type:
- string
- 'null'
maxLength: 50
examples:
- Caucasian
EthnicityPercentage4:
type:
- number
- 'null'
examples:
- 22.3
Ethnicity4:
type:
- string
- 'null'
maxLength: 50
examples:
- Caucasian
EthnicityPercentage5:
type:
- number
- 'null'
examples:
- 22.3
Ethnicity5:
type:
- string
- 'null'
maxLength: 50
examples:
- Caucasian
InterestPercentage1:
type:
- number
- 'null'
minimum: 0
examples:
- 23.3
Interest1:
type:
- string
- 'null'
maxLength: 50
examples:
- Sport
InterestPercentage2:
type:
- number
- 'null'
minimum: 0
examples:
- 23.3
Interest2:
type:
- string
- 'null'
maxLength: 50
examples:
- Family
InterestPercentage3:
type:
- number
- 'null'
minimum: 0
examples:
- 23.3
Interest3:
type:
- string
- 'null'
maxLength: 50
examples:
- Family
InterestPercentage4:
type:
- number
- 'null'
minimum: 0
examples:
- 23.3
Interest4:
type:
- string
- 'null'
maxLength: 50
examples:
- Family
InterestPercentage5:
type:
- number
- 'null'
minimum: 0
examples:
- 23.3
Interest5:
type:
- string
- 'null'
maxLength: 50
examples:
- Camera & Photography
BrandPercentage1:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 23.2
Brand1:
type:
- string
- 'null'
maxLength: 50
examples:
- Adidas
BrandPercentage2:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 23.2
Brand2:
type:
- string
- 'null'
maxLength: 50
examples:
- Adidas
BrandPercentage3:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 23.2
Brand3:
type:
- string
- 'null'
maxLength: 50
examples:
- Adidas
BrandPercentage4:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 23.2
Brand4:
type:
- string
- 'null'
maxLength: 50
examples:
- Adidas
BrandPercentage5:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 23.2
Brand5:
type:
- string
- 'null'
maxLength: 50
examples:
- Adidas
USCityPercentage1:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
USCity1:
type:
- string
- 'null'
maxLength: 50
examples:
- São Paulo, Brazil
USCityPercentage2:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
USCity2:
type:
- string
- 'null'
maxLength: 50
examples:
- São Paulo
USCityPercentage3:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
USCity3:
type:
- string
- 'null'
maxLength: 50
examples:
- São Paulo
USCityPercentage4:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
USCity4:
type:
- string
- 'null'
maxLength: 50
examples:
- São Paulo
USCityPercentage5:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
USCity5:
type:
- string
- 'null'
maxLength: 50
examples:
- São Paulo
CountryPercentage1:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
Country1:
type:
- string
- 'null'
maxLength: 10
examples:
- BR
CountryPercentage2:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
Country2:
type:
- string
- 'null'
maxLength: 10
examples:
- BR
CountryPercentage3:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
Country3:
type:
- string
- 'null'
maxLength: 10
examples:
- BR
CountryPercentage4:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
Country4:
type:
- string
- 'null'
maxLength: 10
examples:
- BR
USStatePercentage1:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
USState1:
type:
- string
- 'null'
maxLength: 2
examples:
- CA
USStatePercentage2:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
USState2:
type:
- string
- 'null'
maxLength: 2
examples:
- CA
USStatePercentage3:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
USState3:
type:
- string
- 'null'
maxLength: 2
examples:
- CA
USStatePercentage4:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
USState4:
type:
- string
- 'null'
maxLength: 2
examples:
- CA
USStatePercentage5:
type:
- number
- 'null'
minimum: 0
maximum: 100
examples:
- 22.3
USState5:
type:
- string
- 'null'
maxLength: 2
examples:
- CA
required:
- SocialId
- Network
- NetworkUser
- SocialNetworkId
minProperties: 4
responses:
'204':
description: Successful
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
type:
type: string
examples:
- CoreException
CoreException:
type: object
properties:
code:
type: integer
examples:
- 400
message:
type: string
examples:
- The socialnetworkid field is required.
required:
- code
- message
required:
- type
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
x-internal: false
servers:
- url: https://apis.creatoriq.com
description: Live
/crm/v2/api/publishers/{publisherIds}/accounts:
get:
tags:
- Publisher
summary: GET social accounts for multiple publishers.
description: Fetch the social accounts information for bulk publishers. Max count of publishers 10
operationId: getMultiplePublishersAccounts
parameters:
- name: key
in: query
description: 'Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
'
required: true
schema:
type: string
enum:
- Id
- PublisherId
examples:
- Id
examples:
default:
value: Id
- name: publisherIds
in: path
description: Comma separated unique Publisher IDs.
required: true
schema:
type: string
pattern: ^[0-9]+(,[0-9]+)*$
examples:
- 99990,99991
examples:
default:
value: 99990,99991
responses:
'200':
description: Response 200
content:
application/json:
schema:
$ref: '#/components/schemas/MultiplePublishersAccounts_2'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: https://apis.creatoriq.com
description: Live
servers:
- url: https://apis.creatoriq.com
description: Live
components:
schemas:
ErrorResponse404PATCHContactDataModel:
type: object
description: Exception
properties:
type:
type: string
description: Exception type
examples:
- CoreException
CoreException:
type: object
description: Exception information
properties:
code:
type: integer
description: Exception status code
format: int32
examples:
- 404
message:
type: string
description: Exception message
examples:
- Supplied ID was not found
required:
- type
SocialAccountModel:
type: object
oneOf:
- $ref: '#/components/schemas/channelItem'
- $ref: '#/components/schemas/socialItem'
POSTContactDataRequest:
type: object
description: POST Contact Data Request
properties:
PrimaryContact:
type: integer
enum:
- 0
- 1
description: PrimaryContact - 0 or 1
format: int32
examples:
- 0
FirstName:
type: string
description: Publisher First Name
examples:
- Publisher First Name
LastName:
type: string
description: Publisher Last Name
examples:
- Publisher Last Name
FullName:
type: string
description: Publisher Full Name
examples:
- Publisher Full Name
FinanceContact:
type: integer
enum:
- 0
- 1
description: Finance Contact attribute - 0 or 1
format: int32
examples:
- 0
ShipToAddress:
type: integer
enum:
- 0
- 1
description: Ship To Address attribute - 0 or 1
format: int32
examples:
- 1
LegalGuardianContact:
type: integer
enum:
- 0
- 1
description: Legal Guardian Contact - 0 or 1
format: int32
examples:
- 0
ContactType:
type: string
description: Contact Type
examples:
- Publisher
PublisherId:
type: integer
description: Unique publisher id
format: int32
examples:
- 8082160
required:
- PublisherId
minProperties: 1
AudienceEmpty:
type: array
description: Return an empty array if the publisher is available, but there is no audience data
examples:
- []
items:
type: object
PublisherDataChangesCollectionEventLog:
type: object
description: EventLog object
properties:
UserName:
type: string
description: Event Log entry Creator name. Unchangeable from API.
examples:
- John Smith
RecordId:
type: integer
description: Record Id
examples:
- 99999999
EventType:
type: string
description: Event Type
examples:
- Unlinked accounts
EventTime:
type: string
description: Event time
examples:
- '2023-01-03 06:15:14.0000000 -07:00'
LastUpdated:
type: string
description: Last updated
examples:
- '2023-01-03 06:15:14.0000000 -07:00'
PublisherId:
type: string
description: Unique publisherId
examples:
- '99999999999'
LogoURL:
type: string
description: Link to image to use for Publisher. If this field is left blank and YouTube ChannelId is specified SocialEdge will attempt to retrieve thumbnail from YouTube API and use it as a default value
examples:
- https://someside.com/someimg.png
PublisherName:
type: string
description: Publisher Name. I.e. John Smith. If this field is left blank and YouTube channel is specified SocialEdge will use YouTube Channel Name as default and will attempt to look this up via Google Plus API
examples:
- John Smith
Note:
type: string
description: Event Log text body
examples:
- Social Facebook account "NameName" (:id) updated
required:
- UserName
PublisherByIdModel:
type: object
allOf:
- $ref: '#/components/schemas/PublisherModel'
- type: object
properties:
LDACompliant:
type: integer
enum:
- 2
- 1
- 0
- null
description: 'Legal Drinking Age (LDA) Compliant flag.
Meanings:
- `2`: Creator is highly likely to have an LDA-compliant audience on their Instagram account(s) (green)
- `1`: Creator is likely to have an LDA-compliant audience on at least one of their Instagram accounts (orange)
- `0`: Creator is unlikely to have an LDA-compliant audience on their Instagram account(s) (red)
- `null`: Creator doesn''t have Instagram accounts. It''s also possible that error has occurred while getting an LDA value
'
examples:
- 1
required:
- LDACompliant
POSTContactResponse400Model:
type: object
description: Exception
properties:
type:
type: string
description: Exception type
examples:
- CoreException
CoreException:
type: object
description: Exception information
properties:
code:
type: integer
description: Exception status code
format: int32
examples:
- 404
message:
type: string
description: Exception message
examples:
- No input data found
required:
- type
MultiplePublishersAccounts:
type: object
description: Publishers by IDs as a keys with array of their Social Accounts
patternProperties:
/^[0-9]+$/:
type: array
description: Publisher's Social Accounts
items:
type: object
properties:
PublisherId:
type: integer
examples:
- 99990
Network:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
examples:
- youtube
NotFound:
type: integer
enum:
- 0
- 1
examples:
- 0
isVerifiedBySocialNetwork:
type: integer
enum:
- 0
- 1
examples:
- 1
CreatedBy:
type: string
examples:
- andy.patinkin
CreatedAt:
type:
- string
- 'null'
format: date-time
examples:
- '2018-05-15 23:49:05'
LogoURL:
type: string
format: URI
examples:
- https://yt3.ggpht.com/eijq408tTlu3XbwlIBeu8RsDG4vGTWb2JTOGKuus3sKdAKoxlq770qVga-p3sCT5PHRVEpYfq1M=s800-c-k-c0x00ffffff-no-rj
FollowersCount:
type: integer
examples:
- 4130000
LikesCount:
type:
- integer
- 'null'
examples:
- 213453
CommentsCount:
type:
- integer
- 'null'
examples:
- 2134
ViewsCount:
type:
- integer
- 'null'
examples:
- 121675291
IsBusiness:
type: 'null'
enum:
- 0
- 1
examples:
- 0
Gender:
type:
- string
- 'null'
examples:
- Female
Language:
type:
- string
- 'null'
examples:
- EN
LastUpdated:
type: string
format: date-time
examples:
- '2023-06-26 11:39:03'
Bio:
type: string
examples:
- Hola, yo soy Ari y subo Gameplays de Minecraft y mas
SocialNetworkId:
type: string
examples:
- UCdgKwvFibviy0AzNJCxOQL0
NetworkUser:
type: string
examples:
- '@arigameplays'
FullName:
type: string
examples:
- Ari Gameplays
required:
- PublisherId
- Network
AddressModel:
type: object
properties:
Id:
type: integer
description: Unique id
format: int32
examples:
- 117938214
FirstName:
type: string
examples:
- First Name
LastName:
type: string
examples:
- Last Name
FullName:
type: string
examples:
- Full Name
AddressLine1:
type:
- string
- 'null'
examples:
- Address Line 1
AddressLine2:
type:
- string
- 'null'
examples:
- Address Line 2
City:
type:
- string
- 'null'
examples:
- New York
ZIPCode:
type:
- string
- 'null'
examples:
- '11111'
State:
type:
- string
- 'null'
examples:
- Florida
Country:
type:
- string
- 'null'
examples:
- USA
Email:
type:
- string
- 'null'
format: email
examples:
- example@gmail.com
Email1:
type:
- string
- 'null'
format: email
examples:
- example1@gmail.com
PhoneNumber:
type:
- string
- 'null'
examples:
- (555) 555-1234
PublisherId:
type: integer
format: int32
examples:
- 3293835
PrimaryContact:
type: integer
enum:
- 0
- 1
description: PrimaryContact - 0 or 1
format: int32
examples:
- 0
EmailExists:
type: boolean
description: Flag if email exists
examples:
- false
Complaint:
type:
- boolean
- 'null'
description: Email Complaint Flag
default: null
examples:
- false
required:
- Id
- PublisherId
SocialAccountItem:
type: object
properties:
Network:
type: string
examples:
- youtube
SocialNetworkId:
type: string
examples:
- UCZsapl0PQ1dZ7pHYoBpRCow
NetworkUser:
type: string
examples:
- UCZsapl0PQ1dZ7pHYoBpRCow
AccountWeight:
type: string
examples:
- '12'
WebReach:
type: string
examples:
- '0'
Title:
type: string
examples:
- Cristiano Ronaldo
Followers:
type: string
examples:
- '2140000'
LinkedBy:
type:
- string
- 'null'
default: null
LinkedAt:
type:
- string
- 'null'
default: null
isVerifiedBySocialNetwork:
type: string
enum:
- '0'
- '1'
Linked:
type: string
enum:
- '0'
- '1'
Unlinked:
type: string
enum:
- '0'
- '1'
LinkBroken:
type: string
enum:
- '0'
- '1'
Business:
type: string
enum:
- '0'
- '1'
TokenInvalidDate:
type:
- string
- 'null'
default: null
DateSocialStatsUpdated:
type: string
description: Timestamp of the most recent successful run of the social-statistics refresh job for this account. Independent of `LastUpdated` and `EngagementCalculated` — the three are driven by separate background jobs and can legitimately differ for the same account.
examples:
- '2023-01-03T12:40:00'
WhitelistingExpirationDate:
type:
- string
- 'null'
default: null
IsCreatorMarketplaceEnabled:
type:
- string
- 'null'
default: null
required:
- Network
- SocialNetworkId
- NetworkUser
CampaignInformationSuccessResponseModel:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- PublisherInCampaign
href:
type: string
description: CreatorIQ API URL to get campaign information,
examples:
- https://apis.creatoriq.com/crm/v1/api/campaign/99999
PublisherInCampaign:
$ref: '#/components/schemas/CampaignModel'
required:
- type
- href
CampaignModel:
type: object
properties:
PublisherId:
type: integer
description: Unique publisher id
examples:
- 8082160
CampaignId:
type: integer
description: Unique campaign id
examples:
- 42066
Status:
type: string
description: Status
examples:
- Auto
CreatedBy:
type: string
description: Name of person
examples:
- Admin
DateCreated:
type: string
description: Created date
examples:
- '2022-12-27 11:32:46'
OfferURLHash:
type:
- string
- 'null'
description: Offer url hash
format: uri
examples:
- https://google.com
Clicks:
type:
- integer
- 'null'
examples:
- 100
Payout:
type:
- number
- 'null'
format: float
default: null
examples:
- 9999
PayoutCap:
type:
- number
- 'null'
format: float
default: null
examples:
- 9990
Note:
type:
- string
- 'null'
default: null
examples:
- Note
LastUpdated:
type: string
description: Last update date
examples:
- '2022-12-27 11:32:46'
UpdatedBy:
type: string
description: User updated the record
examples:
- Jon
RequiredPostsFacebook:
type: integer
description: Required posts count on Facebook
examples:
- 3
RequiredPostsTwitter:
type:
- integer
- 'null'
description: Required posts count on Twitter if Twitter enabled
examples:
- 3
RequiredPostsInstagram:
type:
- integer
- 'null'
description: Required posts count on Instagram if Instagram enabled
examples:
- 4
RequiredPostsVine:
type:
- integer
- 'null'
description: Number required post for Vine
examples:
- 3
RequiredPostsGoogle:
type:
- integer
- 'null'
description: Count required posts for Google
default: null
examples:
- 3
PublisherRequiredPostsYouTube:
type:
- integer
- 'null'
examples:
- 3
PublisherRequiredPostsTumblr:
type:
- integer
- 'null'
default: null
examples:
- 3
PlatformFacebook:
type: integer
enum:
- 0
- 1
description: Flag represents if Facebook enabled or disabled * 0 or null Facebook disabled for Campaign * 1 Facebook enabled for Campaign
PlatformTwitter:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if Twitter enabled or disabled * 0 or null Twitter disabled for Campaign * 1 Twitter enabled for Campaign
PlatformInstagram:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if Instagram enabled or disabled * 0 or null Instagram disabled for Campaign * 1 Instagram enabled for Campaign
PlatformVine:
type: integer
enum:
- 0
- 1
- null
description: Platform Vine use. 0 - false; 1 - true
PlatformGoogle:
type: integer
enum:
- 0
- 1
- null
description: '* 0 or null represents Google disabled
* 1 represents Google enabled for campaign
'
PlatformYouTube:
type: integer
enum:
- 0
- 1
- null
description: '* 0 or null represents YouTube is disabled for campaign
* 1 represents YouTube is enabled for campaign
'
PlatformTumblr:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if Tumblr enabled or disabled * 0 or null Tumblr disabled for Campaign * 1 Tumblr enabled for Campaign
DateRequirementsCompleted:
type:
- string
- 'null'
description: Requirements complete date
examples:
- '2020-02-29'
PlatformPinterest:
type: integer
enum:
- 0
- 1
description: Platform Pinterest
RequiredPostsPinterest:
type: integer
description: Required posts count on Pinterest
examples:
- 33
PlatformSnapchat:
type: integer
enum:
- 0
- 1
description: Platform Snapchat
RequiredPostsSnapchat:
type: integer
description: Required posts count on Snapchat
examples:
- 3
PlatformWeb:
type: integer
enum:
- 0
- 1
description: '* If 0 disable Web for campaign
* If 1 enable Web for campaign
'
RequiredPostsWeb:
type: integer
description: Required posts count on Web
examples:
- 3
Id:
type: integer
description: Unique id
examples:
- 100
AccountsParticipation:
type: string
enum:
- All
- BiggestPerNetwork
- null
examples:
- All
PayoutPaid:
type:
- number
- 'null'
default: null
ContentApproval:
type: string
enum:
- Required
- Network approval required
- null
description: Specify if campaign need content approval or not
examples:
- Required
PayoutPaidTrigger:
type: integer
enum:
- 0
- 1
- null
DateContentSubmitted:
type:
- string
- 'null'
description: Content submitted date
examples:
- '2019-07-10'
DateContentApproved:
type:
- string
- 'null'
examples:
- '2020-02-29'
ContentRejectionNote:
type:
- string
- 'null'
default: null
PlatformMusically:
type: integer
enum:
- 0
- 1
description: 'Flag represents if Musically enabled or disabled
* 0 or null Musically disabled for Campaign
* 1 Musically enabled for Campaign description
'
x-deprecated: true
RequiredPostsMusically:
type: integer
description: Required posts for Musically
default: 0
x-deprecated: true
ConfigurationChanged:
type:
- integer
- 'null'
default: null
PayoutType:
type: string
enum:
- PerPost
- Fixed
- null
RespondByDate:
type:
- string
- 'null'
examples:
- '2020-05-28'
PostApproval:
type: string
enum:
- Required
- Not Required
- null
description: 'Flag for live post approval.
* Required => live post approval enabled
* Not Required => live post approval not enabled
'
DateLastActivityUpdated:
type:
- string
- 'null'
description: Last activity update date
examples:
- '2015-08-19 16:44:35.000'
RequiredPostsJSON:
type:
- string
- 'null'
description: Aggregated list which represents RequiredPost fields in JSON format
examples:
- '{"Facebook":2,"YouTube":2,"Twitter":1,"Instagram":1,"Google":0,"Pinterest":1,"Musically":0,"Tumblr":0,"Snapchat":0,"Web":0,"Twitch":0}'
PlatformsJSON:
type:
- string
- 'null'
description: Aggregated list which represents settings in JSON format
examples:
- '{"Facebook":"1","Instagram":"1","Pinterest":"1","Twitter":"1","Web":"1","YouTube":"1"}'
PlatformTwitch:
type: integer
enum:
- 0
- 1
- null
description: Platform Web use. 0 - false; 1 - true
RequiredPostsTwitch:
type:
- integer
- 'null'
description: Required posts for Twitch
default: null
PlatformLinkedIn:
type: integer
enum:
- 0
- 1
description: Platform LinkedIn use. 0 - false; 1 - true
RequiredPostsLinkedIn:
type: integer
description: Required posts for LinkedIn
default: 0
PlatformTikTok:
type: integer
enum:
- 0
- 1
description: '* If 0 disable TikTok for campaign
* If 1 enable TikTok for campaign
'
RequiredPostsTikTok:
type:
- integer
- 'null'
description: Count required posts for TikTok
default: null
PublisherPlatformWeibo:
type: integer
enum:
- 0
- 1
- null
RequiredPostsWeibo:
type: integer
description: Required posts for Weibo
default: 0
PlatformLine:
type: integer
enum:
- 0
- 1
- null
description: Platform Web use. 0 - false; 1 - true
RequiredPostsLine:
type:
- integer
- 'null'
description: Count required posts for Line
examples:
- 23
StatusGroup:
type: string
description: Status group
examples:
- ActiveInCampaign
HasCReq:
type: integer
enum:
- 0
- 1
description: HasCReq
examples:
- 0
DateLastContacted:
type:
- string
- 'null'
description: Last contacted date with publisher
default: null
examples:
- '2019-09-24 23:33:24.000'
PaymentTerm:
type:
- integer
- 'null'
examples:
- 30
IsPaymentTermInUse:
type: integer
enum:
- 0
- 1
- null
InstructionsForPublishers:
type:
- string
- 'null'
description: General instructions for publishers
examples:
- Launch 3 posts
PurchaseOrderId:
type: string
description: Purchase order Id
examples:
- '9999'
LogoURL:
type: string
description: Link to image.
examples:
- https://someside.com/someimg.png
ThumbLogoURL:
type: string
description: Link to image.
examples:
- https://someside.com/someimg.png
IsSale:
type: integer
enum:
- 0
- 1
default: 0
PartnerId:
type: integer
description: Unique partner id
examples:
- 21
AdvertiserId:
type: integer
description: Unique advertiser id
examples:
- 1244
CampaignName:
type: string
description: Campaign name
examples:
- Coca-Cola
Description:
type:
- string
- 'null'
description: Campaign description
examples:
- Lorem ipsum
SalesPerson:
type:
- string
- 'null'
examples:
- Neo
ExpectedCloseDate:
type:
- string
- 'null'
description: Expected close date campaign
default: null
CID:
type:
- string
- 'null'
default: null
x-deprecated: true
OfferId:
type:
- string
- 'null'
description: Unique offer id. Related with OfferURL
default: null
SubId:
type:
- string
- 'null'
default: null
x-deprecated: true
OfferURL:
type:
- string
- 'null'
description: The URL provided by the client to be tracked in the campaign
format: uri
examples:
- https://google.com
HashTag:
type:
- string
- 'null'
description: Hashtags and keywords you tracked for this campaign
examples:
- USWNT,#TeamNike,Nike,MLS
STATE:
type:
- string
- 'null'
examples:
- Open
Pipeline:
type: string
description: Pipeline
examples:
- Pipeline
PipelineStage:
type:
- string
- 'null'
examples:
- Prospecting
CampaignStatus:
type:
- string
- 'null'
description: Current status of campaign.
examples:
- Closed
StartDate:
type: string
description: Campaign start date
examples:
- '2022-07-01'
EndDate:
type: string
description: Campaign end date
examples:
- '2022-09-01'
Visibility:
type: string
enum:
- By invitation only
- Open to eligible influencers
- Open to all publishers
- null
description: Visibility status for publisher
examples:
- By invitation only
Approval:
type:
- string
- 'null'
default: null
Direct:
type: integer
enum:
- 0
- 1
examples:
- 1
AdvertisingPartner:
type:
- string
- 'null'
description: Advertising partner name
default: null
Probability:
type:
- number
- 'null'
description: The probability that a talent or publisher will join the network
default: null
x-deprecated: true
TermsAndConditions:
type:
- string
- 'null'
description: Terms and conditions url
default: null
x-deprecated: true
ApproveTermsAndConditions:
type: integer
enum:
- 0
- 1
- null
description: Flag represents if terms and condition approved.
x-deprecated: true
TotalBudget:
type:
- number
- 'null'
description: Total budget for campaign
default: null
examples:
- 100
TotalBudgetFromAdvertiser:
type:
- number
- 'null'
description: Initial Brand Offering Amount
default: null
examples:
- 120
MaxWeeklyBudget:
type:
- number
- 'null'
description: Max weekly budget
default: null
examples:
- 2200
MaxMonthlyBudget:
type:
- number
- 'null'
description: Max monthly budget
default: null
examples:
- 300
SpentToDate:
type:
- number
- 'null'
default: null
Objective:
type:
- string
- 'null'
examples:
- Drive product sales
Format:
type:
- string
- 'null'
examples:
- Giveaway
DateTimeCreated:
type: string
description: Created date of campaign
format: date
examples:
- '2015-01-29'
ActivatedBy:
type:
- string
- 'null'
description: Name of the person who activated campaign
examples:
- Admin
x-deprecated: true
ActivationDate:
type:
- string
- 'null'
description: Activation date and time
default: null
x-deprecated: true
LastModified:
type:
- string
- 'null'
description: Last modified date and time
examples:
- '2022-08-03 08:25:00'
LastModifiedBy:
type:
- string
- 'null'
description: Name of the person who made the last changes
examples:
- Admin
ContestsForPublishers:
type:
- string
- 'null'
default: null
x-deprecated: true
InstructionsYouTube:
type:
- string
- 'null'
description: Instructions to publisher for Youtube
default: null
InstructionsYouTubePlaylist:
type:
- string
- 'null'
description: Instructions for Youtube playlist
default: null
InstructionsFacebook:
type:
- string
- 'null'
description: Instructions to publisher for Facebook
default: null
InstructionsTwitter:
type:
- string
- 'null'
description: Instructions to publisher for Twitter
default: null
InstructionsInstagram:
type:
- string
- 'null'
description: Instructions to publisher for Instagram
default: null
InstructionsTumblr:
type:
- string
- 'null'
description: Instructions to publisher for Tumblr
default: null
Benchmarks:
type:
- string
- 'null'
description: Aggregated stats in json format for campaign
default: null
examples:
- '{"InfluencersNum":"3","PostsNum":"4","VideosNum":0,"Reach":0,"ExpectedReach":"","Engagement":0,"Impressions":"10000","VideoViews":0,"TotalSocialConnections":"","YoutubeEngagement":0,"EarnedMedia":0}'
x-remove-response: true
MainBenchmarks:
type:
- string
- 'null'
description: Aggregated field with settings for campaign.
examples:
- '{"InfluencersNum": true, "VideosNum": true, "PostsNum": true, "VideoViews": true, "Engagement": true, "Reach": "", "Impressions": "", "ExpectedReach": true}'
x-remove-response: true
CPC:
type:
- string
- 'null'
default: null
CPA:
type:
- string
- 'null'
default: null
CPS:
type:
- string
- 'null'
default: null
PerformancePayout:
type:
- string
- 'null'
default: null
FixedFee:
type:
- number
- 'null'
default: null
FixedFeeFromAdvertiser:
type:
- string
- 'null'
default: null
examples:
- '3.4'
AllowCustomPayout:
type:
- string
- 'null'
default: null
CPSPayoutPercentage:
type: string
description: CPS Payout
examples:
- '9999'
ConversionTracking:
type: string
description: Conversion Tracking
examples:
- Tracking
PreviewURL:
type: string
description: Preview URL
examples:
- http://google.test.com
DefaultURL:
type: string
description: Default URL
format: URI
examples:
- http://google.test.com
TestURL:
type: string
description: Test URL
examples:
- http://google.test.com
TrackingPixelCode:
type: string
description: Tracking Pixel Code
examples:
- '9999'
AdvertiserName:
type: string
description: Advertiser name
examples:
- Pepsi
AdvertiserDescription:
type: string
description: Advertiser description
examples:
- Description
CPM:
type:
- string
- 'null'
default: null
CPMAmount:
type: string
description: CPM Amount
examples:
- '9999'
CPMAmountFromAdvertiser:
type:
- number
- 'null'
default: null
CPV:
type:
- string
- 'null'
default: null
CPVAmount:
type:
- number
- 'null'
default: null
CPVAmountFromAdvertiser:
type: string
description: CPV amount from advertiser
examples:
- '9999'
AllowCustomPayoutCap:
type:
- string
- 'null'
default: null
Manager:
type: string
description: Campaign manager name
examples:
- John Manager
PerformancePayoutFromAdvertiser:
type: string
description: Performance payout
examples:
- '9999'
InstructionsGoogle:
type:
- string
- 'null'
description: Instructions to publisher for Google
default: null
MultipleHashTagsLogic:
type: string
enum:
- AND
- OR
description: '* AND => all tags must be in post for include to campaign
* OR => one of tags must be in post for include to campaign
'
examples:
- OR
FixedFeeTrigger:
type:
- number
- 'null'
default: null
PayoutCapTrigger:
type:
- string
- 'null'
default: null
LinksForCampaign:
type: string
description: Links to external docs
default: ''
examples:
- http://google.test.com
CPVBudgetTrigger:
type: string
description: Trigger
examples:
- Trigger
CPCBudgetTrigger:
type: string
description: Trigger
examples:
- Trigger
InstructionsYouTubeTrigger:
type: integer
enum:
- 0
- 1
- null
x-remove-response: true
InstructionsFacebookTrigger:
type: integer
enum:
- 0
- 1
- null
x-remove-response: true
InstructionsTwitterTrigger:
type: integer
enum:
- 0
- 1
- null
x-remove-response: true
InstructionsInstagramTrigger:
type: integer
enum:
- 0
- 1
- null
x-remove-response: true
InstructionsGoogleTrigger:
type: integer
enum:
- 0
- 1
- null
x-remove-response: true
Tags:
type:
- string
- 'null'
description: Comma separated tags list for campaign
examples:
- '"Authentication","Brazil","Celebrity Creators"'
InstructionsVine:
type:
- string
- 'null'
description: Instructions to publisher for Vine platform
examples:
- 2 posts
InstructionsVineTrigger:
type: integer
enum:
- 0
- 1
- null
examples:
- 1
x-remove-response: true
ContentLead:
type:
- string
- 'null'
description: Content Lead name
examples:
- John Doe
DateInfluencerProposalDue:
type:
- string
- 'null'
default: null
x-deprecated: true
MediaBudget:
type:
- number
- 'null'
description: Media budget for campaign
examples:
- 1000
ProductionBudget:
type:
- number
- 'null'
description: Production budget settings
examples:
- 12000
TalentBudget:
type:
- number
- 'null'
description: Part of budget settings.
default: null
TravelBudget:
type:
- number
- 'null'
examples:
- 8000
CreativeBackground:
type:
- string
- 'null'
description: Part of creative brief settings. What is the brand in question all about, and why are they interested in working with network
default: null
examples:
- HTML
CreativeObjective:
type:
- string
- 'null'
description: Part of creative brief settings.
default: null
examples:
- objective
CreativeKeyMessage:
type:
- string
- 'null'
description: Part of creative brief settings
default: null
examples:
- What is the main message, theme or slogan for the campaign?
CreativeTargetMarket:
type:
- string
- 'null'
description: Part of creative brief settings.Quantitative (Age/Gender/Geo for both primary and secondary audiences)
default: null
CreativeInformationConsiderations:
type:
- string
- 'null'
description: Part of creative brief settings.
default: null
CreativeDeliverables:
type:
- string
- 'null'
description: Part of creative brief settings.Number of creators needed, etc.
default: null
CreativeStepsTimings:
type:
- string
- 'null'
description: Part of creative brief settings.
default: null
InfluencerInfluencerOverview:
type:
- string
- 'null'
description: Part of creative brief settings.
default: null
examples:
- Spokeswomen, brand ambassador, fashion/beauty bloggers, and brand advocates
InfluencerQuantReqs:
type:
- string
- 'null'
description: How many creators do we need?
examples:
- 10k followers on at least one social platform
InfluencerAudience:
type:
- string
- 'null'
description: Part of creative brief settings.Demographics and audience segmentation
examples:
- Female, 18 to 45
InfluencerValueProp:
type:
- string
- 'null'
examples:
- HTML template
InfluencerIndicativeInfluencers:
type:
- string
- 'null'
examples:
- Creator Brief - Indicative Creators
InfluencerInformation:
type:
- string
- 'null'
examples:
- Tag @CocaCola
Currency:
type: string
description: Currency of campaign
minLength: 2
maxLength: 5
examples:
- USD
Paid:
type: integer
enum:
- 0
- 1
Contest:
type:
- string
- 'null'
default: null
InstructionsPinterest:
type:
- string
- 'null'
description: Instructions to publisher for Pinterest
default: null
InstructionsPinterestTrigger:
type: integer
enum:
- 0
- 1
- null
x-remove-response: true
InstructionsSnapchat:
type:
- string
- 'null'
description: Instructions to publisher for Snapchat
default: null
InstructionsSnapchatTrigger:
type: integer
enum:
- 0
- 1
- null
description: Instructions for Snapchat Trigger
x-remove-response: true
InstructionsTumblrTrigger:
type: integer
enum:
- 0
- 1
- null
description: Instructions for Tumblr Trigger
x-remove-response: true
InstructionsWeb:
type:
- string
- 'null'
description: Instructions to publisher for web
default: null
InstructionsWebTrigger:
type: integer
enum:
- 0
- 1
- null
description: Instructions for Web Trigger
x-remove-response: true
InstructionsMusically:
type:
- string
- 'null'
description: Instructions to publisher for Musically
default: null
x-deprecated: true
InstructionsMusicallyTrigger:
type:
- integer
- 'null'
description: Instructions for Musically Trigger
default: null
x-deprecated: true
SocialReportMetrics:
type:
- string
- 'null'
description: Json object with metrics. Used in UI
default: null
ProducerFee:
type:
- number
- 'null'
default: null
examples:
- 1095.5
SubmitForApprovalBy:
type:
- string
- 'null'
examples:
- '2016-07-08'
x-deprecated: true
PublishAfter:
type:
- string
- 'null'
description: Publish posts or content after date this date
examples:
- '2017-06-01 00:00:00.0000000 +00:00'
SubmitByDate:
type:
- string
- 'null'
description: Submit content before date
examples:
- '2016-01-20 16:00:00.0000000 -08:00'
PublishBefore:
type:
- string
- 'null'
description: Publish posts or content before date this date
examples:
- '2017-09-30 00:00:00.0000000 +00:00'
AccessControl:
type:
- string
- 'null'
description: Technical field. Need for access control for campaign
default: null
x-remove-response: true
NetworkCampaignID:
type:
- string
- 'null'
description: External id of campaign. Can be setup manually
examples:
- IO-522558
NetworkCampaignName:
type:
- string
- 'null'
description: External campaign name
default: null
Tier:
type:
- string
- 'null'
description: Campaign category
examples:
- CocaCola
AccountManagerName:
type: string
description: Account manager name
examples:
- John Doe
YoutubeEngagementMetric:
type: string
enum:
- Views
- Reach
- null
description: Youtube engagement metric for campaign
CampaignUpdateFrequency:
type:
- string
- 'null'
default: null
DateLastActivityUpdated_GMT:
type: string
description: Date last activity
examples:
- '2017-09-30 00:00:00.0000000 +00:00'
InstructionsTwitch:
type: string
description: Twitch instruction
examples:
- Instruction
InstructionsTwitchTrigger:
type: string
description: Instruction
examples:
- Instruction
InstructionsLinkedIn:
type: string
description: Instruction
examples:
- Instruction
InstructionsLinkedInTrigger:
type: string
description: Instruction
examples:
- Instruction
InstructionsTikTokTrigger:
type: string
description: Instruction
examples:
- Instruction
InstructionsTikTok:
type: string
description: Instruction
examples:
- Instruction
InstructionsWeiboTrigger:
type: string
description: Instruction
examples:
- Instruction
InstructionsWeibo:
type: string
description: Instruction for weibo network
examples:
- Instruction
InstructionsLineTrigger:
type: string
description: Instruction
examples:
- Instruction
InstructionsLine:
type: string
description: Instruction
examples:
- Instruction
ContractRequired:
type: integer
enum:
- 0
- 1
- null
description: '* 0 or null contract not required
* 1 contract required
'
ContractTermsAcceptedAt:
type:
- string
- 'null'
description: Contract Terms and Conditions accept date
examples:
- '2022-02-03'
ContractTermsAcceptedBy:
type:
- string
- 'null'
description: Contract Terms and Conditions accept person
examples:
- admin
CollaborationVisibility:
type:
- string
- 'null'
default: null
InstructionsJSON:
type:
- string
- 'null'
description: Instructions settings on JSON format
examples:
- '{"FacebookTrigger":"1","GoogleTrigger":"1","InstagramTrigger":"1","TwitterTrigger":"1","VineTrigger":"1","YouTubeTrigger":"1"}'
TrackingLevel:
type: string
enum:
- publisher
- post
- null
TrackingAddUTM:
type: integer
enum:
- 0
- 1
- null
description: Add UTM Parameters for tracking links
TrackingLinkCreationType:
type: string
enum:
- mass-generate
- link-by-link
- null
BrandKeyword:
type:
- string
- 'null'
description: List of brand keywords
examples:
- null
CustomFieldValue1:
type:
- string
- 'null'
examples:
- aaa
CustomFieldValue2:
type:
- string
- 'null'
examples:
- aaa
CustomFieldValue3:
type:
- string
- 'null'
examples:
- aaa
CustomFieldValue4:
type:
- string
- 'null'
examples:
- aaa
CustomFieldValue5:
type:
- string
- 'null'
examples:
- aaa
CreatedById:
type:
- integer
- 'null'
description: Id of the person who create campaign
examples:
- 1244
CampaignManagerId:
type:
- integer
- 'null'
description: Unique campaign manager id
examples:
- 123
DivisionId:
type:
- integer
- 'null'
description: Division id
default: null
examples:
- 12123
CampaignVisibility:
type: integer
enum:
- 0
- 1
description: 'Campaign visibility for publisher.
* If 0 Campaign not visible to publisher
* If 1 Campaign visible to publisher
'
examples:
- 1
ThumbLogoUrl:
type:
- string
- 'null'
description: Small logo url for campaign
examples:
- https://socialedge-campaigns.s3.amazonaws.com/thumb_7382.png
required:
- PublisherId
Channel:
type: object
properties:
ChannelId:
type: integer
description: Internal unique Id
format: int32
examples:
- 17982764
ChannelName:
type: string
description: Channel name in Youtube
examples:
- ZendayaVEVO
Channel:
type: string
description: Channel ID in Youtube
examples:
- UCVQ2Z9dNQ2aJJ10f6SgBH0g
Title:
type: string
description: Channel title in Youtube
examples:
- ZendayaVEVO
LogoURL:
type: string
description: Link to logo
examples:
- https://yt3.ggpht.com/ytc/AMLnZu84MgVNNeswv0Vwz4IJzSilI_qQkx1JIRXsqrNvYw=s800-c-k-c0x00ffffff-no-rj-mo
Summary:
type:
- string
- 'null'
default: null
PublisherId:
type: integer
description: Id of publisher which attached to Youtube channel
format: int32
examples:
- 9202903
ContractId:
type:
- integer
- 'null'
description: Uniq id of contract publisher
default: null
NetworkId:
type: integer
description: Id of partner
format: int32
examples:
- 141
NetworkName:
type:
- string
- 'null'
description: Name of partner
default: null
SubNetworkId:
type:
- string
- 'null'
description: Internal id for technical use
default: null
SubNetworkName:
type:
- string
- 'null'
description: Internal name for technical use
default: null
Category:
type:
- string
- 'null'
description: Category of channel
default: null
RecruiterName:
type:
- string
- 'null'
description: Name of user which added channel
default: null
examples:
- Admin
Status:
type: string
description: Status of publisher in network
examples:
- Open - In process
AccountManagerName:
type:
- string
- 'null'
default: null
examples:
- Admin
AffiliateManagerName:
type:
- string
- 'null'
default: null
DateFirstContractSigned:
type:
- string
- 'null'
default: null
DateActivated:
type:
- string
- 'null'
default: null
MonthActivated:
type:
- string
- 'null'
default: null
DateFirstNetworkVideoViews:
type:
- string
- 'null'
default: null
MonthFirstNetworkVideoViews:
type:
- string
- 'null'
default: null
YTProductCategory:
type:
- string
- 'null'
default: null
YTLanguage:
type:
- string
- 'null'
description: Language of youtube channel
examples:
- English
YTGeoRegion:
type: string
examples:
- US
YTGender:
type:
- string
- 'null'
default: null
YTAgeRange:
type:
- string
- 'null'
default: null
AuthorName:
type:
- string
- 'null'
default: null
AuthorUserId:
type:
- string
- 'null'
default: null
CustomTag1:
type:
- string
- 'null'
default: null
CustomTag2:
type:
- string
- 'null'
default: null
CustomTag3:
type:
- string
- 'null'
default: null
CustomField1:
type:
- string
- 'null'
default: null
CustomValue1:
type:
- string
- 'null'
default: null
CustomField2:
type:
- string
- 'null'
default: null
CustomValue2:
type:
- string
- 'null'
default: null
CustomField3:
type:
- string
- 'null'
default: null
CustomValue3:
type:
- string
- 'null'
default: null
ContentOwner:
type: string
examples:
- Admin
TotalSubscribers:
type: integer
description: Count of subscribers for this channel
format: int32
examples:
- 1310000
TotalViews:
type: string
description: Count of views channel
examples:
- '390807217'
TotalVideos:
type: integer
description: Count of videos channel
format: int32
examples:
- 35
ChannelSize:
type:
- string
- 'null'
default: null
CreateDateTime:
type: string
description: DateTime when channel created
examples:
- '2011-03-01 19:18:47'
LastUpdated:
type: string
format: date-time
examples:
- '2023-01-09T02:21:46-08:00'
UpdatedBy:
type: string
description: Name of user which updated channel info
examples:
- Discovery
NotFound:
type:
- boolean
- 'null'
description: Is channel exists on Youtube
default: null
AverageMonthlyViews:
type: number
examples:
- 2749551.9859155
LastComments:
type:
- string
- 'null'
default: null
LastLikes:
type:
- string
- 'null'
default: null
LastDislikes:
type:
- string
- 'null'
default: null
AvgLastViewsPerVideo:
type:
- string
- 'null'
default: null
AvgLastCommentsPerVideo:
type:
- string
- 'null'
default: null
AvgLastLikesPerVideo:
type:
- string
- 'null'
default: null
AvgLastDislikesPerVideo:
type:
- string
- 'null'
default: null
AvgLastSharesPerVideo:
type:
- string
- 'null'
default: null
AvgLastFacebookSharesPerVideo:
type:
- string
- 'null'
default: null
AvgLastTwitterSharesPerVideo:
type:
- string
- 'null'
default: null
AvgLastMinutesWatchedPerVideo:
type:
- string
- 'null'
default: null
LastVideoLength:
type:
- string
- 'null'
default: null
StatusChangedManually:
type: integer
enum:
- 0
- 1
format: int32
examples:
- 0
TotalLikes:
type:
- string
- 'null'
default: null
examples:
- '2323'
TotalDislikes:
type:
- string
- 'null'
default: null
TotalFavoritesAdded:
type:
- string
- 'null'
default: null
TotalFavoritesRemoved:
type:
- string
- 'null'
default: null
TotalShares:
type:
- string
- 'null'
default: null
EstimatedMinutesWatched:
type:
- string
- 'null'
default: null
AverageViewDuration:
type:
- string
- 'null'
default: null
TotalComments:
type:
- string
- 'null'
default: null
examples:
- '34'
IncludeInContract:
type: integer
enum:
- 0
- 1
format: int32
examples:
- 1
Protected:
type: integer
enum:
- 0
- 1
format: int32
examples:
- 0
AvgLastFacebookLikesPerVideo:
type:
- string
- 'null'
default: null
AvgLastFacebookCommentsPerVideo:
type:
- string
- 'null'
default: null
AvgLastGooglePlusSharesPerVideo:
type:
- string
- 'null'
default: null
AvgLastPinterestSharesPerVideo:
type:
- string
- 'null'
default: null
DateLastVideoUploaded:
type: string
examples:
- '2016-02-23 08:00:00'
DateDeActivated:
type:
- string
- 'null'
default: null
DateStatusChanged:
type:
- string
- 'null'
default: null
GooglePlusUserId:
type:
- string
- 'null'
default: null
LogoHighResURL:
type: string
examples:
- https://yt3.ggpht.com/ytc/AMLnZu84MgVNNeswv0Vwz4IJzSilI_qQkx1JIRXsqrNvYw=s88-c-k-c0x00ffffff-no-rj-mo
AVV30:
type:
- string
- 'null'
default: null
AVV60:
type:
- string
- 'null'
default: null
AVV90:
type:
- string
- 'null'
default: null
Tags:
type:
- string
- 'null'
default: null
CreatedBy:
type: string
examples:
- Admin
CreatedAt:
type: string
examples:
- '2019-03-07 18:35:59'
CreatorRole:
type: string
examples:
- Account owner
VerifiedBy:
type:
- string
- 'null'
default: null
VerifiedAt:
type:
- string
- 'null'
default: null
LinkedBy:
type:
- string
- 'null'
default: null
LinkedAt:
type:
- string
- 'null'
default: null
AvgLastInstagramSharesPerVideo:
type:
- string
- 'null'
default: null
Last30DaysViews:
type:
- string
- 'null'
default: null
MonthToDateViews:
type:
- string
- 'null'
default: null
LastMonthViews:
type:
- string
- 'null'
default: null
examples:
- '2323'
DateScraped:
type:
- string
- 'null'
default: null
CPP:
type:
- number
- 'null'
default: null
examples:
- 23
CPE:
type:
- number
- 'null'
default: null
examples:
- 23
CPM:
type:
- number
- 'null'
examples:
- 23
Engagement:
type:
- string
- 'null'
default: null
EngagementRate:
type:
- string
- 'null'
default: null
isVerifiedBySocialNetwork:
type: integer
format: int32
examples:
- 1
IsTokenInvalid:
type: integer
format: int32
examples:
- 0
TokenInvalidDate:
type:
- string
- 'null'
default: null
DateAnalytics:
type:
- string
- 'null'
default: null
NewSocialAccountID:
type: integer
description: Internal Id for technical use
format: int32
examples:
- -739328
Network:
const: youtube
examples:
- youtube
SocialNetworkId:
type: string
examples:
- UCVQ2Z9dNQ2aJJ10f6SgBH0g
NetworkUser:
type: string
examples:
- UCVQ2Z9dNQ2aJJ10f6SgBH0g
NumberOfPosts:
type: integer
format: int32
examples:
- 35
DateSocialStatsUpdated:
type: string
description: Timestamp of the most recent successful run of the social-statistics refresh job for this account. Independent of `LastUpdated` and `EngagementCalculated` — the three are driven by separate background jobs and can legitimately differ for the same account.
format: date-time
examples:
- '2023-01-17T11:09:00+00:00'
Contracts:
type: object
properties:
type:
type: string
examples:
- ContractCollection
href:
type: string
examples:
- https://apis.creatoriq.com/crm/v1/api/data/youtube/channel/17982764/contracts
AvgLastEngagementPerVideoYT:
type: integer
format: int32
examples:
- 0
Linked:
type: boolean
Unlinked:
type: boolean
LinkBroken:
type: boolean
Verified:
type: boolean
Business:
type: boolean
SocialEngagement:
$ref: '#/components/schemas/socialEngagement'
required:
- ChannelId
- Channel
- PublisherId
tagSchema:
type: object
properties:
ids:
type: array
description: List of publisher ids
minItems: 1
items:
type: integer
format: int32
examples:
- 232323
tags:
type: array
description: List of tags
minItems: 1
examples:
- - Tag1
- Tag2
items:
type: string
required:
- ids
- tags
Summary:
type: object
properties:
MPID:
type:
- string
- 'null'
default: null
examples:
- '100705751'
CJPID:
type:
- string
- 'null'
default: null
examples:
- '100705751'
PublisherId:
type: integer
description: Uniq publisherId
examples:
- 1244
PublisherName:
type: string
examples:
- Messi
LegalGuardian:
type:
- string
- 'null'
default: null
OutsideManagerName:
type:
- string
- 'null'
default: null
ManagementCompany:
type:
- string
- 'null'
default: null
NetworkPublisherId:
type: string
examples:
- '10000497901'
InvitedToPortal:
type: integer
enum:
- 0
- 1
default: 0
LogoURL:
type:
- string
- 'null'
default: null
examples:
- https://s3-us-west-1.amazonaws.com/social-pictures-storage/LogoPublisher/113437_Logo.jpg
ThumbLogoUrl:
type:
- string
- 'null'
default: null
examples:
- https://s3-us-west-1.amazonaws.com/social-pictures-storage/LogoPublisher/113437_Logo.jpg
PrimaryContactId:
type: integer
examples:
- 100717622
ShipToContactId:
type:
- integer
- 'null'
default: null
examples:
- 100717622
FinanceContactId:
type:
- integer
- 'null'
default: null
examples:
- 100717622
OutsideManagerContactId:
type:
- integer
- 'null'
default: null
LegalGuardianContactId:
type:
- string
- 'null'
default: null
DateOfBirth:
type:
- string
- 'null'
default: null
examples:
- '2010-04-17'
Age:
type: integer
format: int32
minimum: 0
examples:
- 12
Language:
type:
- string
- 'null'
default: null
examples:
- English
Language2:
type:
- string
- 'null'
default: null
examples:
- English
EthnicBackground:
type:
- string
- 'null'
default: null
Gender:
type:
- string
- 'null'
examples:
- Male
RecruiterName:
type:
- string
- 'null'
examples:
- Admin
AccountManagerName:
type:
- string
- 'null'
examples:
- Admin
PartnerId:
type: integer
examples:
- 21
NetworkName:
type: string
examples:
- Test
SubNetworkId:
type:
- string
- 'null'
default: null
SubNetworkName:
type:
- string
- 'null'
default: null
FlagshipProperty:
type: string
description: Bigger social account
examples:
- therock
Category:
type:
- string
- 'null'
description: Comma separated list of categories
default: null
examples:
- Entertainment
PublisherType:
type:
- string
- 'null'
default: null
BrandsWishes:
type:
- string
- 'null'
default: null
BrandsContracts:
type:
- string
- 'null'
default: null
PressList:
type:
- string
- 'null'
default: null
SubCategories:
type:
- string
- 'null'
default: null
examples:
- '"Beauty-General","Beauty-SkinCare"'
Size:
type: string
examples:
- Diamond
Status:
type: string
examples:
- Active
StatusCategory:
type: string
examples:
- In Network
ExpectedCloseDate:
type: string
examples:
- '2022-03-10'
Probability:
type:
- string
- 'null'
default: null
LeadSource:
type: string
examples:
- Broad Search
DatedClaimed:
type:
- string
- 'null'
default: null
examples:
- '2022-08-02 09:37:38'
DateInvited:
type:
- string
- 'null'
default: null
examples:
- '2022-08-02 09:37:38'
DateWelcomeEmailSent:
type:
- string
- 'null'
default: null
examples:
- '2021-09-29'
DateFirstChannelActivated:
type:
- string
- 'null'
default: null
DateJoinedNetwork:
type:
- string
- 'null'
description: The date when creator was activated, i.e. status changed to active
default: null
DateLastContact:
type:
- string
- 'null'
default: null
examples:
- '2022-12-20 16:30:34'
DatePublisherStateChanged:
type:
- string
- 'null'
default: null
examples:
- '2023-01-04 16:00:00'
DateJoinedPublisherPortal:
type:
- string
- 'null'
default: null
examples:
- '2023-01-04 17:00:00'
DateLastPublisherPortalLogin:
type:
- string
- 'null'
default: null
Description:
type: string
examples:
- Lorem Ipsum
LastUpdated:
type: string
examples:
- '2021-11-05 05:15:24'
UpdatedBy:
type: string
examples:
- Admin
HasAdSense:
type: integer
enum:
- 0
- 1
examples:
- 0
Unsubscribe:
type: integer
enum:
- 0
- 1
examples:
- 0
DontContact:
type: integer
enum:
- 0
- 1
examples:
- 0
AdSenseDisabled:
type: integer
enum:
- 0
- 1
examples:
- 0
AdSenseIssue:
type:
- string
- 'null'
default: null
OtherNetwork:
type:
- string
- 'null'
default: null
AllowReApply:
type:
- string
- 'null'
default: null
RegistrationCompleted:
type: integer
enum:
- 0
- 1
InterfaceLocale:
type:
- string
- 'null'
default: null
PrimaryContact:
type: integer
enum:
- 1
- 0
ShipToAddress:
type: integer
enum:
- 0
- 1
FullName:
type:
- string
- 'null'
examples:
- John Doe
FirstName:
type:
- string
- 'null'
examples:
- Doe
LastName:
type:
- string
- 'null'
examples:
- John
StreetAddress:
type:
- string
- 'null'
default: null
examples:
- London
StreetAddress2:
type:
- string
- 'null'
default: null
examples:
- London, 32
City:
type:
- string
- 'null'
default: null
examples:
- London
State:
type:
- string
- 'null'
default: null
examples:
- Alaska
ZipCode:
type:
- string
- 'null'
default: null
examples:
- '5400'
Country:
type:
- string
- 'null'
default: null
examples:
- US
Email:
type: string
format: email
examples:
- John@mail.com
Email1:
type: string
format: email
examples:
- John@mail.com
PhoneNumber1:
type:
- string
- 'null'
default: null
examples:
- '334343'
PhoneNumber1Description:
type:
- string
- 'null'
default: null
examples:
- Lorem Ipsum
PhoneNumber2:
type:
- string
- 'null'
default: null
examples:
- Lorem Ipsum
PhoneNumber2Description:
type:
- string
- 'null'
default: null
examples:
- Lorem Ipsum
PhoneNumber3:
type:
- string
- 'null'
default: null
examples:
- '23433434'
PhoneNumber3Description:
type:
- string
- 'null'
default: null
examples:
- Lorem Ipsum
Fax:
type:
- string
- 'null'
default: null
examples:
- Lorem Ipsum
Notes:
type:
- string
- 'null'
default: null
LegalGuardianContact:
type:
- integer
- 'null'
default: null
examples:
- 0
TW_Followers:
type:
- string
- 'null'
default: null
examples:
- '32'
TW_NumOfAccounts:
type:
- integer
- 'null'
default: null
examples:
- 10
VN_Followers:
type:
- string
- 'null'
default: null
examples:
- '23'
VN_NumOfAccounts:
type:
- string
- 'null'
default: null
examples:
- '23'
IN_Followers:
type:
- string
- 'null'
default: null
examples:
- '23'
IN_NumOfAccounts:
type:
- string
- 'null'
default: null
examples:
- '110'
FB_Likes:
type:
- string
- 'null'
default: null
examples:
- '110530'
FB_TotalViews:
type:
- string
- 'null'
default: null
FB_TotalVideos:
type:
- string
- 'null'
default: null
FB_AverageMonthlyViews:
type:
- string
- 'null'
default: null
FB_AvgLastViewsPerVideo:
type:
- string
- 'null'
default: null
FB_AvgLastLikesPerVideo:
type:
- string
- 'null'
default: null
FB_AvgLastCommentsPerVideo:
type:
- string
- 'null'
default: null
FB_NumOfAccounts:
type:
- integer
- 'null'
default: null
examples:
- 20
NumberOfChannels:
type:
- integer
- 'null'
default: null
examples:
- 10
YT_Subscribers:
type: string
examples:
- '22323'
YT_TotalViews:
type: string
examples:
- '23232323'
YT_TotalVideos:
type: string
examples:
- '2323233'
YT_AverageMonthlyViews:
type: number
format: float
examples:
- 55741438.180629
FinanceContact:
type:
- string
- 'null'
default: null
DateRecruitingStarted:
type: string
description: The date when creator was added to CRM
examples:
- '2019-05-10 13:31:33'
DatePublisherActivated:
type: string
examples:
- '2019-05-10'
DatePublisherDeActivated:
type:
- string
- 'null'
default: null
ContractSummary:
type:
- string
- 'null'
default: null
ChannelList:
type: array
items:
type: object
properties:
ChannelName:
type: string
examples:
- Super Channel
Title:
type: string
examples:
- Super Channel
required:
- ChannelName
- Title
Categories:
type: string
examples:
- Gaming
Relationship:
type:
- string
- 'null'
default: null
examples:
- Single
Children:
type:
- string
- 'null'
default: null
examples:
- Male
Female
Male
Pets:
type:
- string
- 'null'
default: null
examples:
- '"Fish(es)","Dog(s)","Cat(s)","Bird(s)"'
Glasses:
type:
- string
- 'null'
default: null
EyeColor:
type:
- string
- 'null'
default: null
examples:
- Blue
HairColor:
type:
- string
- 'null'
default: null
ContentRating:
type:
- string
- 'null'
default: null
examples:
- PG-13
BrandsWorked:
type:
- string
- 'null'
default: null
BrandsWishWork:
type:
- string
- 'null'
default: null
BrandsWontWork:
type:
- string
- 'null'
default: null
InternalDescription:
type:
- string
- 'null'
default: null
ShortDescription:
type:
- string
- 'null'
default: null
examples:
- Shor description of publisher
AgeRange:
type:
- object
- 'null'
properties:
Min:
type: integer
examples:
- 19
Max:
type: integer
examples:
- 32
default: null
CustomValue1:
type:
- string
- 'null'
default: null
CustomValue2:
type:
- string
- 'null'
default: null
CustomValue3:
type:
- string
- 'null'
default: null
CustomValue4:
type:
- string
- 'null'
default: null
CustomValue5:
type:
- string
- 'null'
default: null
LogoHighResURL:
type:
- string
- 'null'
format: URI
default: null
Tags:
type:
- string
- 'null'
description: \| separated List of tags
default: null
examples:
- '"AutoTag|Gameplay"'
YT_AvgLastViewsPerVideo:
type:
- string
- 'null'
default: null
YT_AvgLastLikesPerVideo:
type:
- string
- 'null'
default: null
YT_AvgLastDislikesPerVideo:
type:
- string
- 'null'
default: null
YT_AvgLastCommentsPerVideo:
type:
- string
- 'null'
default: null
AvgLastEngagementPerVideoYT:
type:
- string
- 'null'
default: null
AvgLastEngagementPerVideoSocial:
type:
- string
- 'null'
default: null
AvgLastEngagementPerVideoTotal:
type:
- string
- 'null'
default: null
GP_Followers:
type:
- string
- 'null'
default: null
GP_NumOfAccounts:
type:
- string
- 'null'
default: null
examples:
- '3'
TB_Followers:
type:
- string
- 'null'
default: null
TB_NumOfAccounts:
type:
- string
- 'null'
default: null
PN_Followers:
type:
- string
- 'null'
default: null
PN_NumOfAccounts:
type:
- string
- 'null'
default: null
SC_Followers:
type:
- string
- 'null'
default: null
SC_NumOfAccounts:
type:
- string
- 'null'
default: null
WB_Followers:
type:
- string
- 'null'
default: null
WB_NumOfAccounts:
type:
- integer
- 'null'
default: null
ML_Followers:
type:
- string
- 'null'
default: null
ML_NumOfAccounts:
type:
- string
- 'null'
default: null
TCH_Followers:
type:
- string
- 'null'
default: null
TCH_NumOfAccounts:
type:
- string
- 'null'
default: null
TCH_TotalViews:
type:
- string
- 'null'
default: null
AVV30:
type:
- string
- 'null'
default: null
AVV60:
type:
- string
- 'null'
default: null
AVV90:
type:
- string
- 'null'
default: null
FlagshipSocialNetwork:
type: string
examples:
- Youtube
SocialAccountsList:
type: object
properties:
SOCIAL_NETWORK_NAME:
type: array
items:
$ref: '#/components/schemas/SocialAccountItem'
FlagshipPropertyTitle:
type: string
description: Social account name biggest account of publisher
examples:
- Therock
TotalSubscribers:
type: string
examples:
- '@3223'
SalesSheetImageURL:
type:
- string
- 'null'
default: null
HaveKids:
type:
- string
- 'null'
default: null
HavePets:
type:
- string
- 'null'
default: null
PoliticalAffiliation:
type:
- string
- 'null'
default: null
PhoneType:
type:
- string
- 'null'
default: null
ShirtSize:
type:
- string
- 'null'
default: null
HasDriverLicense:
type:
- string
- 'null'
default: null
HasPassport:
type:
- string
- 'null'
default: null
ShoeSize:
type:
- string
- 'null'
default: null
PantSize:
type:
- string
- 'null'
default: null
PantWaist:
type:
- string
- 'null'
default: null
PantLength:
type:
- string
- 'null'
default: null
Height:
type:
- string
- 'null'
default: null
examples:
- '23'
WillTravel:
type:
- string
- 'null'
default: null
DressSize:
type:
- string
- 'null'
default: null
LDACompliant:
type:
- string
- 'null'
default: null
AccessControl:
type:
- string
- 'null'
default: null
Token:
type: string
examples:
- '3343344'
CIQCertifiedFlag:
type: integer
enum:
- 0
- 1
CIQCertifiedFlagDate:
type:
- string
- 'null'
default: null
AudienceFlags:
type:
- integer
- 'null'
default: null
EngagementFlags:
type:
- integer
- 'null'
default: null
GrowthFlags:
type:
- integer
- 'null'
default: null
TotalFraudFlags:
type:
- integer
- 'null'
default: null
CustomValue6:
type:
- string
- 'null'
default: null
CustomValue7:
type:
- string
- 'null'
default: null
CustomValue8:
type:
- string
- 'null'
default: null
CustomValue9:
type:
- string
- 'null'
default: null
CustomValue10:
type:
- string
- 'null'
default: null
CustomValue11:
type:
- string
- 'null'
default: null
CustomValue12:
type:
- string
- 'null'
default: null
CustomValue13:
type:
- string
- 'null'
default: null
CustomValue14:
type:
- string
- 'null'
default: null
CustomValue15:
type:
- string
- 'null'
default: null
CustomValue16:
type:
- string
- 'null'
default: null
CustomValue17:
type:
- string
- 'null'
default: null
TT_Followers:
type:
- string
- 'null'
default: null
examples:
- '23'
TT_NumOfAccounts:
type:
- string
- 'null'
default: null
examples:
- '23'
WE_Followers:
type:
- string
- 'null'
default: null
examples:
- '23'
WE_NumOfAccounts:
type:
- string
- 'null'
default: null
examples:
- '23'
LI_Followers:
type:
- string
- 'null'
default: null
examples:
- '23'
LI_NumOfAccounts:
type:
- string
- 'null'
default: null
examples:
- '23'
LN_Followers:
type:
- string
- 'null'
default: null
examples:
- '23'
LN_NumOfAccounts:
type:
- string
- 'null'
default: null
examples:
- '23'
TCH_Subscribers:
type:
- string
- 'null'
default: null
examples:
- '23'
TCH_PeakViewers:
type:
- string
- 'null'
default: null
examples:
- '23'
TCH_AvgViewers:
type:
- string
- 'null'
default: null
examples:
- '23'
TCH_ViewsVideoCount:
type:
- string
- 'null'
default: null
examples:
- '23'
FollowersCountJSON:
type: string
description: Json object which aggregated statistics by followers count
examples:
- '{"youtube":14800,"twitter":411,"instagram":269,"tumblr":0}'
TotalSocialAccounts:
type: integer
examples:
- 2323
PrimarySocialAccountId:
type: integer
examples:
- 620033
EmailExists:
type: integer
enum:
- 0
- 1
TV_Followers:
type:
- string
- 'null'
default: null
TV_TotalViews:
type:
- string
- 'null'
default: null
TV_NumOfAccounts:
type:
- string
- 'null'
default: null
TV_Subscribers:
type:
- string
- 'null'
default: null
TV_PeakViewers:
type:
- string
- 'null'
default: null
TV_AvgViewers:
type:
- string
- 'null'
default: null
TV_AvgVideoViews:
type:
- string
- 'null'
default: null
ChannelName:
type:
- string
- 'null'
default: null
examples:
- TheRock
Channel:
type:
- string
- 'null'
default: null
examples:
- UCewwji3r23
ChannelId:
type:
- integer
- 'null'
default: null
examples:
- 133434
ContractId:
type:
- string
- 'null'
default: null
examples:
- '2323'
LinkToDocument:
type:
- string
- 'null'
default: null
YT_Last30DaysViews:
type:
- integer
- 'null'
default: null
examples:
- 73506
EngagementPercentage:
type:
- string
- 'null'
default: null
LinkAccountsPage:
type:
- string
- 'null'
default: null
Linked:
type: integer
enum:
- 0
- 1
examples:
- 0
Unlinked:
type: integer
enum:
- 0
- 1
examples:
- 1
LinkBroken:
type: integer
enum:
- 0
- 1
examples:
- 1
Verified:
type: integer
enum:
- 0
- 1
examples:
- 1
HasPayments:
type: integer
enum:
- 0
- 1
examples:
- 1
Payable:
type: integer
enum:
- 0
- 1
examples:
- 1
NotPayableReason:
type:
- string
- 'null'
default: null
examples:
- The creator has not started onboarding.
PayableStatusUpdatedAt:
type:
- string
- 'null'
examples:
- '2021-09-12 18:49:31'
PayPalFirstName:
type:
- string
- 'null'
default: null
PayPalLastName:
type:
- string
- 'null'
default: null
PayPalEmail:
type:
- string
- 'null'
format: email
default: null
PublisherCampaignsListLink:
type:
- string
- 'null'
default: null
examples:
- https://google.com
GamesPlayed:
type: object
oneOf:
- type: array
description: No games played
examples:
- []
- type: object
properties:
Twitch:
type: array
items:
type: object
properties:
Name:
type: string
examples:
- 'Fall Guys: Ultimate Knockout'
LastPlayed:
type: string
examples:
- '2022-06-25T20:25:36Z'
PlayedTimes:
type: integer
examples:
- 3
required:
- Name
- LastPlayed
- PlayedTimes
required:
- Twitch
CampaignsCount:
type: integer
examples:
- 6
PromoCodesCount:
type: integer
examples:
- 0
required:
- PublisherId
socialItem:
type: object
description: Social Network Account
properties:
type:
const: Social
description: Type of property requested
examples:
- Social
href:
type: string
description: CreatorIQ URL to retrieve data for the Social account
examples:
- https://apis.creatoriq.com/crm/v1/api/data/social/17982768
Social:
$ref: '#/components/schemas/Social'
required:
- type
- href
- Social
PublisherModel:
type: object
properties:
Id:
type: integer
description: Internal CreatorIQ identifier. This value is unique and immutable (cannot be changed). It is used by the system to uniquely identify the entity. This ID can be found in the UI (e.g., in the browser URL). To use this identifier in update requests, you must explicitly specify the query parameter `key=id`
examples:
- 2386944
NetworkPublisherId:
type: string
description: Same as `PublisherId`. This field contains the same value and is provided for compatibility. It represents an external identifier that can be updated and is used by default in update operations.
examples:
- '10001356198'
PublisherId:
type: string
description: External identifier used for integrations and mapping with third-party systems. This value can be updated. By default, this identifier is used when updating an account (unless `key=id` is specified)
examples:
- '10001356198'
ChannelId:
type:
- string
- 'null'
description: YouTube unique channel Identifier. i.e. UCkDbLiXbx6CIRZuyW9sZK1g
examples:
- UCkDbLiXbx6CIRZuyW9sZK1g
ChannelName:
type:
- string
- 'null'
description: YouTube Channel Name. If this field is left blank and YouTube ChannelId is specified SocialEdge will attempt to retrieve ChannelName via YouTube API
examples:
- My YouTube channel
ChannelTitle:
type:
- string
- 'null'
description: Primary YouTube Channel title
examples:
- My YouTube Channel title
ContentOwner:
type:
- string
- 'null'
description: Content owner
examples:
- John Smith
Token:
type:
- string
- 'null'
description: YouTube access token for this channel
examples:
- 20c965fe7b0c3aec8a596a74b8f4deee
PublisherName:
type: string
description: Publisher Name. I.e. John Smith. If this field is left blank and YouTube channel is specified SocialEdge will use YouTube Channel Name as default and will attempt to look this up via Google Plus API
examples:
- John Smith
LastUpdated:
type: string
description: Date when publisher last updated
examples:
- '2022-03-01 08:12:26'
Status:
type:
- string
- 'null'
description: Publisher status
default: null
examples:
- Active
StatusCategory:
type:
- string
- 'null'
description: Status category
default: null
examples:
- In Network
Language:
type:
- string
- 'null'
description: Publisher's primary language. I.E. English. If this field is left blank and YouTube channel is specified SocialEdge will attempt to look this up via YouTube API
default: null
examples:
- English
SecondaryLanguage:
type:
- string
- 'null'
description: Publisher's secondary language
default: null
examples:
- English
Size:
type:
- string
- 'null'
description: This field can be used to categorize Publishers. I.e. 'Star', 'Starlet' or 'Large', 'Small'
default: null
examples:
- Starlet
LeadSource:
type:
- string
- 'null'
description: I.e. Web, Outreach, Referral
default: null
examples:
- Web
EthnicBackground:
type:
- string
- 'null'
description: I.e. Asian, Caucasian, African American
default: null
examples:
- Asian
Category:
type:
- string
- 'null'
description: Primary category. I.e. Music, Style, Fitness
default: null
examples:
- Style
SubCategories:
type:
- string
- 'null'
description: Comma separated subcategories for publisher
default: null
Gender:
type:
- string
- 'null'
description: I.e. Male, Female, Transgender
default: null
examples:
- Female
DateOfBirth:
type:
- string
- 'null'
description: Publisher's date of birth
default: null
examples:
- 15/05/1996 16:30:20
Description:
type:
- string
- 'null'
description: If this field is left blank and YouTube channel is specified SocialEdge will attempt to look up YouTube channel description via YouTube API and use it as default value
default: null
examples:
- My channel description
PublisherStatus:
type:
- string
- 'null'
description: Used to indicate recruiting status. I.e. 'Contract Signed', 'Rejected'. Refer to product documentation for list of options
default: null
examples:
- In Network
PublisherStatusCategory:
type:
- string
- 'null'
description: Additional information about recruiting status. I.e. 'Waiting for Activation', 'Too Small'. This field is used together with PublisherStatus. Refer to product documentation for list of options
default: null
examples:
- Waiting for Activation
LogoURL:
type:
- string
- 'null'
description: Link to image to use for Publisher. If this field is left blank and YouTube ChannelId is specified SocialEdge will attempt to retrieve thumbnail from YouTube API and use it as a default value
default: null
examples:
- https://someside.com/someimg.png
DateRecruitingStarted:
type:
- string
- 'null'
description: The date when creator was added to CRM
default: null
examples:
- 15/05/1996 16:30:20
LegalGuardian:
type: string
description: Publisher's legal guardian if Publisher is a minor
examples:
- John Smith
LegalGuardianEmail:
type: string
description: Publisher's legal guardian email
examples:
- johnsmith@gmail.com
HasAdSense:
type: boolean
examples:
- false
AdSenseIssue:
type: string
description: Indicates if Publisher has AdSence issues for Primary YouTube Channel
examples:
- ''
RecruiterName:
type:
- string
- 'null'
description: Name of the person who recruited or is recruiting Publisher
default: null
examples:
- John Smith
SubNetworkName:
type: string
description: Use to farther categorize Publishers and Channels, usually based on YouTube network. I.e. Owned and Operated
examples:
- Owned and Operated
InterfaceLocale:
type:
- string
- 'null'
default: null
Address:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- Address
href:
type: string
description: CreatorIQ API URL to get publisher’s contact information.
examples:
- https://apis.creatoriq.com/crm/v1/api/data/contact/111209220
required:
- type
FinanceContact:
$ref: '#/components/schemas/ContactModel'
LegalGuardianContact:
$ref: '#/components/schemas/ContactModel'
ShipToContact:
$ref: '#/components/schemas/ContactModel'
Contract:
type: object
properties:
ChannelId:
type: string
description: YouTube channel Identifier. i.e. UCkDbLiXbx6CIRZuyW9sZK1g or human readable unique channel name
pattern: ^[a-zA-Z0-9]+$
examples:
- UCkDbLiXbx6CIRZuyW9sZK1g
Summary:
type: string
description: Contract summary. I.e. 'Active, Rev-share, 70%; Expires 04/09/2015;
pattern: ^[a-zA-Z0-9]+$
examples:
- Active
Link:
type: string
description: Contract document location link
pattern: ^[a-zA-Z0-9]+$
examples:
- Link
DateSigned:
type: string
description: Date when Contract is signed
examples:
- 15/05/1996 16:30:20
DateExpired:
type: string
description: Date when Contract will expire
examples:
- 15/05/1996 16:30:20
DateActive:
type: string
description: Date when Contract is active
examples:
- 15/05/1996 16:30:20
DateSent:
type: string
description: Date when Contract is sent
examples:
- 15/05/1996 16:30:20
EchoSignTemplate:
type: string
description: EchoSign Template
pattern: ^[a-zA-Z0-9]+$
examples:
- Template
BonusPeriod:
type: boolean
description: Bonus Period
examples:
- false
RenewalPeriod:
type: boolean
description: Renewal Period
examples:
- false
Active:
type: boolean
description: Is contract active
examples:
- false
required:
- ChannelId
Demographics:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- Demographics
href:
type: string
description: CreatorIQ API URL to get publisher’s demographic information.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/10001356198/demographics
required:
- type
- href
Summary:
type: object
properties:
type:
const: Summary
description: Type of Search
href:
type: string
description: CreatorIQ API URL to get publisher’s summary.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/10001356198/summary
required:
- type
- href
SocialAccounts:
type: object
properties:
type:
const: SocialAccounts
description: Type of Search
examples:
- SocialAccounts
href:
type: string
description: CreatorIQ API URL to get publisher’s social account information summary.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/10001356198/socialAccounts
required:
- type
- href
InfoForAdvertisers:
type: object
properties:
type:
const: InfoForAdvertisers
description: Type of Search
examples:
- InfoForAdvertisers
href:
type: string
description: CreatorIQ API URL to get advertiser information for the publisher.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/99999999999/infoForAdvertisers
required:
- type
- href
accounts:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- Accounts
href:
type: string
description: CreatorIQ API URL to get detailed information about publisher’s social networks and social engagement.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/99999999999/accounts
required:
- type
- href
channels:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- channels
href:
type: string
description: CreatorIQ API URL to get detailed information about publisher’s YouTube channels.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/99999999999/channels
required:
- type
- href
Campaigns:
type: object
properties:
type:
const: Campaigns
description: Type of Search
examples:
- Campaigns
href:
type: string
description: CreatorIQ API URL to get detailed information about publisher’s campaigns.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/10001356198/campaigns
required:
- type
- href
AvailableCampaigns:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- CampaignCollection
href:
type: string
description: CreatorIQ API URL to get information about campaigns available for a publisher.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/99999999999/availableCampaigns
required:
- type
- href
Notes:
type: object
properties:
type:
const: NotesCollection
description: Type of Search
examples:
- NotesCollection
href:
type: string
description: CreatorIQ API URL to get publisher notes.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/99999999999/notes
required:
- type
- href
Log:
type: object
properties:
type:
const: EventLogCollection
description: Type of Search
examples:
- EventLogCollection
href:
type: string
description: CreatorIQ API URL to get event logs for changes to publisher social account information.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/99999999999/log
required:
- type
- href
Messages:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- Messages
href:
type: string
description: CreatorIQ API URL to get publisher messages.
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/99999999999/messages
required:
- type
- href
AllowedPaymentMethods:
type: array
examples:
- - Paypal
items:
type: string
description: List of allowed payment methods
examples:
- Paypal
InternalDescription:
type:
- string
- 'null'
description: Internal notes about Publisher
default: null
examples:
- Loyal and willing
TalentAgency:
type:
- string
- 'null'
description: Publisher's talent agency
default: null
examples:
- My talent agency
Kids:
type:
- string
- 'null'
description: Publisher's kids
default: null
examples:
- One
Unsubscribe:
type:
- boolean
- 'null'
description: Unsubscribe flag
default: null
examples:
- false
DontContact:
type:
- boolean
- 'null'
description: Don't contact this publisher
default: null
examples:
- false
Tags:
type:
- string
- 'null'
description: Publisher''s tags (comma separated)'
default: null
examples:
- News,Sport
TagNames:
type:
- string
- 'null'
description: Publisher''s tags (comma separated)'
default: null
examples:
- Nike, Nike Running, Running, Micro, Sports, APAC
DateJoinedNetwork:
type:
- string
- 'null'
description: The date when creator was activated, i.e. status changed to active
default: null
examples:
- 15/05/1996 16:30:20
CustomValue1:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue2:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue3:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue4:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue5:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue6:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue7:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue8:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue9:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue10:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue11:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue12:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue13:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue14:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue15:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue16:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
CustomValue17:
type:
- string
- 'null'
description: Publisher's value for custom field defined in Network configuration
default: null
examples:
- CustomValue
DateLastPublisherPortalLogin:
type:
- string
- 'null'
description: Date last publisher logged in to portal
default: null
examples:
- 15/05/1996 16:30:20
TermsAccepted:
type:
- boolean
- 'null'
description: Terms accepted by publisher
default: null
examples:
- false
Height:
type:
- number
- 'null'
description: Publisher's height
default: null
examples:
- 1111
HeightUnit:
type:
- string
- 'null'
description: Publisher's height unit
default: null
examples:
- Unit
DressSize:
type:
- string
- 'null'
description: 'Publisher''s dress size (JSON data) Format: {"ShowSize":"","DressSize":"0","PantSize":"0","ShirtSize":"","PantWaist":"0","PantLength":"0"}'
default: null
examples:
- '{"ShowSize":"","DressSize":"0","PantSize":"0","ShirtSize":"","PantWaist":"0","PantLength":"0"}'
Glasses:
type:
- string
- 'null'
description: Publisher's glasses
default: null
examples:
- Glass
EyeColor:
type:
- string
- 'null'
description: Publisher's eye color
default: null
examples:
- Red
HairColor:
type:
- string
- 'null'
description: Publisher's hair color
default: null
examples:
- Red
Relationship:
type:
- string
- 'null'
description: Publisher's relationship
default: null
examples:
- Single
Children:
type:
- string
- 'null'
description: Publisher's children
default: null
examples:
- Female, 5 years
Male, 4 years
Pets:
type:
- string
- 'null'
description: Publisher's pets
default: null
examples:
- Dog(s),Cat(s),Bird,Fish(es),Other
HaveKids:
type:
- boolean
- 'null'
description: Flag which dedicates if publisher has kids
default: null
examples:
- true
HavePets:
type:
- boolean
- 'null'
description: Flag which dedicates if publisher has pets
default: null
examples:
- true
ContentRating:
type:
- string
- 'null'
description: Publisher's content rating
default: null
examples:
- '99'
OtherInfo:
type:
- string
- 'null'
default: null
BrandsWontWork:
type:
- string
- 'null'
default: null
examples:
- Cola
BrandsWorked:
type:
- string
- 'null'
default: null
BrandsWishWork:
type:
- string
- 'null'
default: null
LinkAccountsPage:
type: string
description: Publisher's link accounts page URL
examples:
- https://app.creatoriq.com/link_accounts/?id=999999999999999999999999&hash=de2aa72d400e44afb1bedff78f063fb56ca1ed4a
BrandedLinkAccountsPage:
type:
- string
- 'null'
description: Publisher's link accounts page URL on branded site (if set)
examples:
- https://branded-url.site/link_accounts/?id=999999999999999999999999&hash=de2aa72d400e44afb1bedff78f063fb56ca1ed4a
PublisherCampaignsListLink:
type: string
description: Publisher campaigns list link
examples:
- https://app.creatoriq.com/dashboard/?id=999999999999999999999999&hash=de2aa72d400e44afb1bedff78f063fb56ca1ed4a
FraudFlags:
type: object
properties:
CIQCertifiedFlag:
type: boolean
examples:
- false
CIQCertifiedFlagDate:
type:
- string
- 'null'
default: null
AudienceFlags:
type: boolean
examples:
- false
EngagementFlags:
type: boolean
examples:
- false
GrowthFlags:
type: boolean
examples:
- false
TotalFraudFlags:
type: integer
examples:
- 1111
CampaignsCount:
type: integer
description: Campaigns count
examples:
- 1111
TotalSubscribers:
type: string
description: Total subscribers
examples:
- '9999999'
Country:
type: string
description: Country
examples:
- USA
MPID:
type:
- string
- 'null'
default: null
CJPID:
type:
- string
- 'null'
default: null
examples:
- '100748169'
required:
- Id
- PublisherId
socialEngagement:
type: object
properties:
EngagementRate30Days:
type:
- string
- 'null'
default: null
EngagementRate60Days:
type:
- string
- 'null'
default: null
EngagementRate90Days:
type:
- string
- 'null'
default: null
EngagementRate20Posts:
type: number
examples:
- 0.0137
EngagementRateLifetime:
type: number
examples:
- 0.0121
PostsCount30Days:
type: integer
format: int32
examples:
- 0
PostsCount60Days:
type: integer
format: int32
examples:
- 0
PostsCount90Days:
type: integer
format: int32
examples:
- 0
PostsCountLifetime:
type: integer
format: int32
examples:
- 36
Engagement30Days:
type: integer
format: int32
examples:
- 0
Engagement60Days:
type: integer
format: int32
examples:
- 0
Engagement90Days:
type: integer
format: int32
examples:
- 0
Engagement20Posts:
type: integer
format: int32
examples:
- 1756560
EngagementLifetime:
type: integer
format: int32
examples:
- 4729812
SharesPerPost30Days:
type:
- string
- 'null'
default: null
SharesPerPost60Days:
type:
- string
- 'null'
default: null
SharesPerPost90Days:
type:
- string
- 'null'
default: null
SharesPerPost20Posts:
type:
- string
- 'null'
default: null
SharesPerPostLifetime:
type:
- string
- 'null'
default: null
LikesPerPost30Days:
type:
- string
- 'null'
default: null
LikesPerPost60Days:
type:
- string
- 'null'
default: null
LikesPerPost90Days:
type:
- string
- 'null'
default: null
LikesPerPost20Posts:
type: number
description: Channel CPE
examples:
- 9999
CPM:
type: number
description: Channel CPM
examples:
- 9999
required:
- EngagementRate30Days
CampaignScheduledPostsSuccessResponseModel:
type: object
properties:
type:
const: ScheduledPostsCollection
description: Type of Search
examples:
- ScheduledPostsCollection
href:
type: string
description: CreatorIQ API URL to get publisher's scheduled posts
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/123455/scheduledPosts?key=Id
count:
type: integer
description: Number of records in current response
default: 20
examples:
- 20
total:
type: integer
description: Total number of found rows
examples:
- 100
page:
type: integer
description: Current page
default: 1
examples:
- 1
ScheduledPostsCollection:
type: array
description: List of Scheduled Posts
items:
type: object
properties:
type:
const: ScheduledPost
examples:
- ScheduledPost
ScheduledPost:
type: object
description: Scheduled Post information
properties:
PostId:
type: integer
description: Unique post Id
examples:
- 15165007
PublisherId:
type: integer
description: Unique publisher id
examples:
- 8082160
SocialAccountId:
type:
- string
- 'null'
default: null
examples:
- '6829119326546723846'
CampaignId:
type: integer
description: Unique campaign id
examples:
- 42066
CompletedPostId:
type:
- integer
- 'null'
default: null
examples:
- 122323
CompletedPostUrl:
type:
- string
- 'null'
format: URI
default: null
SocialNetwork:
type: string
enum:
- Facebook
- Instagram
- YouTube
- Web
- Twitter
- Twitch
- TikTok
- Snapchat
- Pinterest
description: Social network name
examples:
- Facebook
ScheduledDateTime:
type:
- string
- 'null'
examples:
- '2015-06-04 10:00:01.000'
PublishBefore:
type:
- string
- 'null'
description: Should be posted before date
examples:
- 'false'
ActualDateTime:
type:
- string
- 'null'
examples:
- '2015-06-04 10:00:01.000'
Instructions:
type: string
description: Instructions for post
default: ''
InstructionsTrigger:
type:
- integer
- 'null'
description: '> Equal 1 if instructions enabled'
default: null
examples:
- 1
Status:
type:
- string
- 'null'
description: Current status of the post
default: null
examples:
- Not submitted
PostType:
type: string
examples:
- Video
DesiredPostCaption:
type:
- string
- 'null'
default: null
DesiredPostText:
type:
- string
- 'null'
default: null
DesiredPostMediaURL:
type:
- string
- 'null'
format: URL
default: null
Payout:
type:
- number
- 'null'
default: null
LastModifiedBy:
type: string
description: Name of person who make last update
examples:
- Admin
LastUpdated:
type: string
description: Last update date
examples:
- '2022-12-27 11:32:46'
CreatedBy:
type: string
description: Name of person who create
examples:
- Admin
Approval:
type:
- string
- 'null'
default: null
examples:
- '0'
SubmitByDate:
type:
- string
- 'null'
default: null
examples:
- '2022-12-11T22:00:00+00:00'
PublishAfter:
type:
- string
- 'null'
description: Should be posted after date
default: null
examples:
- '2022-12-12T22:00:00+00:00'
ContentApproval:
type: string
enum:
- Required
- Not Required
description: Name of content approval person
examples:
- Not Required
PostNote:
type:
- string
- 'null'
description: Notes of post
default: null
PostStatus:
type:
- string
- 'null'
default: null
ActualPostStatus:
type:
- string
- 'null'
default: null
SubmitBeforeDate:
type:
- string
- 'null'
description: Should be submit before date
default: null
PostContent:
type: object
description: Post information
properties:
type:
type: string
description: Type of Search
examples:
- PostContent
href:
type: string
description: CreatorIQ API URL to get creator's instagram timeline
examples:
- https://apis.creatoriq.com/crm/v1/api/postContent
count:
type: integer
description: Number of records in current response
examples:
- 20
total:
type: integer
description: Total number of found rows
examples:
- 100
page:
type: integer
description: Current page
examples:
- 1
PostContentCollection:
type: array
description: List of posts
items:
type: object
required:
- type
- href
- PostContentCollection
Description:
type:
- string
- 'null'
default: null
PaymentStatus:
type:
- string
- 'null'
default: null
PaymentStatusDate:
type:
- string
- 'null'
default: null
PaymentErrorMessage:
type:
- string
- 'null'
default: null
PaymentRejectionNote:
type:
- string
- 'null'
default: null
RequirementsCompletedAt:
type:
- string
- 'null'
default: null
PaymentTerm:
type:
- string
- 'null'
default: null
PaymentDueDate:
type:
- string
- 'null'
default: null
CampaignCode:
type:
- string
- 'null'
default: null
examples:
- 1HQLLV01B01
required:
- PublisherId
required:
- type
- ScheduledPost
required:
- type
- href
- count
- total
- ScheduledPostsCollection
updatePublisherSocialAccountResponseModel:
type: object
oneOf:
- $ref: '#/components/schemas/socialItem'
- $ref: '#/components/schemas/channelItem'
- type: object
description: Empty object
maxProperties: 0
default: {}
examples:
- {}
channelItem:
type: object
description: Youtube Channel Account
properties:
type:
const: Channel
description: Type of property requested
examples:
- Channel
href:
type: string
description: CreatorIQ URL to retrieve data for the Youtube channel
examples:
- https://apis.creatoriq.com/crm/v1/api/data/youtube/channel/17982764
Channel:
$ref: '#/components/schemas/Channel'
required:
- type
- href
- Channel
EventLogCollection:
type: object
properties:
type:
type: string
description: Name of entity
examples:
- EventLog
EventLog:
type: array
items:
$ref: '#/components/schemas/EventLog'
required:
- type
- EventLog
Social:
type: object
properties:
Id:
type: integer
format: int32
examples:
- 22213070
PublisherId:
type: integer
description: Unique id
format: int32
examples:
- 11539204
Network:
type: string
enum:
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
examples:
- instagram
Type:
type:
- string
- 'null'
default: null
SocialNetworkId:
type: string
examples:
- '427553890'
NetworkUser:
type: string
description: Social network handle
examples:
- leomessi
Followers:
type: string
examples:
- '420661173'
SocialStats:
type: object
description: Aggregated representation of social account statistics
NetworkSize:
type:
- string
- 'null'
default: null
DateSocialStatsUpdated:
type: string
description: Timestamp of the most recent successful run of the social-statistics refresh job for this account. Independent of `LastUpdated` and `EngagementCalculated` — the three are driven by separate background jobs and can legitimately differ for the same account.
format: date-time
examples:
- '2023-01-17T13:42:00-08:00'
LastUpdated:
type: string
description: Timestamp of the most recent change to any field on this social account record by any background job. Independent of `DateSocialStatsUpdated` and `EngagementCalculated`, which track specific ETL jobs — these three timestamps can legitimately differ for the same account.
format: date-time
examples:
- '2023-01-17T14:37:15-08:00'
UpdatedBy:
type: string
examples:
- Nike Demo cron
NotFound:
type:
- string
- 'null'
default: null
Protected:
type:
- string
- 'null'
default: null
NetworkId:
type: integer
format: int32
examples:
- 21
NumberOfPosts:
type: integer
format: int32
examples:
- 981
EngagementPercentage:
type:
- string
- 'null'
default: null
TotalComments:
type: integer
format: int32
examples:
- 0
TotalLikes:
type: integer
format: int32
examples:
- 0
LastPostDate:
type: string
examples:
- '2020-03-30 11:11:00'
Last30DaysPosts:
type:
- string
- 'null'
default: null
Last30DaysEngagementPercentage:
type:
- string
- 'null'
default: null
LogoURL:
type: string
examples:
- https://scontent-sea1-1.xx.fbcdn.net/v/t51.2885-15/43818140_2116018831763532_3803033961098117120_n.jpg?_nc_cat=1&ccb=1-7&_nc_sid=86c713&_nc_ohc=Z3z81d-fQZMAX_4a6wD&_nc_ht=scontent-sea1-1.xx&edm=AL-3X8kEAAAA&oh=00_AfDk7giZuN6_2r-p_PfvVVCurfR-dFCHRiZ-8JScbJwXZA&oe=63CC1A3F
ThumbnailURL:
type: string
examples:
- https://scontent-den4-1.xx.fbcdn.net/v/t51.2885-15/43818140_2116018831763532_3803033961098117120_n.jpg?_nc_cat=1&ccb=1-7&_nc_sid=86c713&_nc_ohc=OtqkpsoxfdQAX-IMjk8&_nc_ht=scontent-den4-1.xx&edm=AL-3X8kEAAAA&oh=00_AfCq436O3WvsnX_20ihzCNjpkWlt01BpS23wd03V6VSmqw&oe=63CA1FFF
Location:
type:
- string
- 'null'
default: null
Gender:
type: string
examples:
- Male
Tags:
type:
- string
- 'null'
default: null
AvgCommentsPerPost:
type: number
format: float
examples:
- 2.34
AvgLikesPerPost:
type: number
format: float
examples:
- 3.45
AvgSharesPerPost:
type:
- string
- 'null'
default: null
TotalViews:
type:
- string
- 'null'
default: null
CreatedBy:
type: string
examples:
- Denis Kovalyov
CreatedAt:
type: string
examples:
- '2020-02-13 11:49:19'
CreatorRole:
type: string
examples:
- Account owner
VerifiedBy:
type:
- string
- 'null'
default: null
VerifiedAt:
type:
- string
- 'null'
default: null
LinkedBy:
type:
- string
- 'null'
default: null
LinkedAt:
type:
- string
- 'null'
default: null
TextPosts:
type:
- string
- 'null'
examples:
- '23'
ImagePosts:
type:
- string
- 'null'
examples:
- '23'
VideoPosts:
type:
- string
- 'null'
examples:
- '33434'
MonthlyUniqueVisitors:
type:
- string
- 'null'
default: null
examples:
- '34344'
AlexaRank:
type:
- string
- 'null'
default: null
CompeteRank:
type:
- string
- 'null'
default: null
DateScraped:
type:
- string
- 'null'
default: null
CPP:
type:
- string
- 'null'
default: null
CPE:
type:
- string
- 'null'
default: null
CPM:
type:
- string
- 'null'
default: null
RecommendedCPP:
type:
- string
- 'null'
default: null
Bio:
type:
- string
- 'null'
examples:
- Bienvenidos a la cuenta oficial de Instagram de Leo Messi / Welcome to the official Leo Messi Instagram account
AvgViewsPerPost:
type:
- string
- 'null'
default: null
MonthlyVisitors:
type:
- string
- 'null'
default: null
AvgTimeSpentOnPost:
type:
- string
- 'null'
default: null
Language:
type: string
examples:
- Spanish
NumberFollowing:
type:
- string
- 'null'
examples:
- '32'
FullName:
type: string
examples:
- leomessi
IsTokenInvalid:
type: integer
enum:
- 0
- 1
format: int32
examples:
- 0
WebSessions:
type:
- string
- 'null'
default: null
PageViews:
type:
- string
- 'null'
default: null
ViewsPerSession:
type:
- string
- 'null'
default: null
SessionDuration:
type:
- string
- 'null'
default: null
ThreeMonthAverageVisitors:
type:
- string
- 'null'
default: null
ThreeMonthAverageViewsPerSession:
type:
- string
- 'null'
default: null
ThreeMonthAverageSessionDuration:
type:
- string
- 'null'
default: null
GaProfile:
type:
- string
- 'null'
default: null
isVerifiedBySocialNetwork:
type: integer
enum:
- 0
- 1
format: int32
examples:
- 1
IsBusiness:
type: integer
enum:
- 0
- 1
format: int32
examples:
- 1
TokenInvalidDate:
type:
- string
- 'null'
default: null
IGFBId:
type:
- string
- 'null'
default: null
Stories:
type:
- string
- 'null'
default: null
StoriesViewCount:
type:
- string
- 'null'
default: null
examples:
- '23'
NewSocialAccountID:
type: integer
format: int32
examples:
- 3753859
PeakStreamConcurrentViews:
type:
- string
- 'null'
default: null
AvgStreamConcurrentViews:
type:
- string
- 'null'
default: null
Subscribers:
type:
- string
- 'null'
default: null
VideoDuration:
type:
- string
- 'null'
default: null
EstimatedUniqueStreamViews:
type:
- string
- 'null'
default: null
ViewsVideoCount:
type:
- string
- 'null'
default: null
examples:
- '23'
Linked:
type: boolean
Unlinked:
type: boolean
LinkBroken:
type: boolean
Verified:
type: boolean
Business:
type: boolean
WhitelistingExpirationDate:
type:
- string
- 'null'
default: null
IsBoostable:
type: boolean
VideoInformation:
type: object
properties:
TotalViews:
type:
- string
- 'null'
default: null
TotalVideos:
type:
- string
- 'null'
default: null
AverageMonthlyViews:
type:
- string
- 'null'
default: null
AvgLastViewsPerVideo:
type:
- string
- 'null'
default: null
AvgLastCommentsPerVideo:
type:
- string
- 'null'
default: null
AvgLastLikesPerVideo:
type:
- string
- 'null'
default: null
AvgLastDislikesPerVideo:
type:
- string
- 'null'
default: null
AvgLastSharesPerVideo:
type:
- string
- 'null'
default: null
AvgLastMinutesWatchedPerVideo:
type:
- string
- 'null'
default: null
LastVideoLength:
type:
- string
- 'null'
default: null
TotalLikes:
type:
- string
- 'null'
default: null
TotalDislikes:
type:
- string
- 'null'
default: null
TotalFavoritesAdded:
type:
- string
- 'null'
default: null
TotalFavoritesRemoved:
type:
- string
- 'null'
default: null
TotalShares:
type:
- string
- 'null'
default: null
EstimatedMinutesWatched:
type:
- string
- 'null'
default: null
AverageViewDuration:
type:
- string
- 'null'
default: null
AvgLastFacebookLikesPerVideo:
type:
- string
- 'null'
default: null
AvgLastFacebookCommentsPerVideo:
type:
- string
- 'null'
default: null
AvgLastGooglePlusSharesPerVideo:
type:
- string
- 'null'
default: null
AvgLAstPinterestSharesPerVideo:
type:
- string
- 'null'
default: null
DateLastVideoUploaded:
type:
- string
- 'null'
default: null
SocialEngagement:
$ref: '#/components/schemas/socialEngagement'
required:
- Id
- PublisherId
- Network
- SocialNetworkId
updatePublisherSocialAccountBody:
type: object
properties:
accountId:
type: string
description: Social Account ID
examples:
- '7554368935252'
network:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
description: Social Network name
examples:
- instagram
required:
- accountId
- network
EventLog:
type: object
properties:
Type:
type: string
description: Event Log type. Can be name of general Event Group or any other abstract category.
examples:
- Social account updated
Note:
type: string
description: Event Log text body
examples:
- Social Facebook account \"NameName\" (:id) updated
Time:
type: string
description: 'Event Log entity timestamp. Format is: Y-m-d H:i:s.'
examples:
- '2020-10-16 18:41:55'
UserName:
type: string
description: Event Log entry Creator name. Unchangeable from API.
examples:
- John Smith
Link:
type:
- string
- 'null'
description: External link to supporting document or any other resource.
default: null
examples:
- https://link.com
required:
- Type
- Note
- Time
ContactModel:
type: object
properties:
FirstName:
type: string
description: First name
examples:
- Christy
LastName:
type: string
description: First name
examples:
- Weimann
FullName:
type: string
description: First name
examples:
- Christy Weimann
Email:
type: string
description: Email
examples:
- Estevan.Conn54@yahoo.com
Email1:
type: string
description: Email
examples:
- Robb82@gmail.com
AddressLine1:
type: string
description: Address
examples:
- Robert Robertson, 1234 NW Bobcat Lane, St. Robert
AddressLine2:
type: string
description: Address
examples:
- Robert Robertson, 1234 NW Bobcat Lane, St. Robert
City:
type: string
description: City
examples:
- Boston
State:
type: string
description: State
examples:
- Massachusetts
Zip:
type: string
description: Zip
examples:
- 02108
Country:
type: string
description: Country
examples:
- USA
required:
- FirstName
Audience:
type: object
properties:
'9999999':
type: object
description: Social Id
properties:
Demographics:
type: object
properties:
RowNumber:
type: integer
description: Row number
examples:
- 1
SocialId:
type: integer
description: Uniq social Id
examples:
- 9999999
SocialNetworkId:
type: string
description: Uniq social network Id
examples:
- '9999999'
SocialNetworkName:
type: string
description: Social network name
examples:
- John Smith
Network:
type: string
description: Source network
examples:
- instagram
Female:
type: integer
enum:
- 0
- 1
description: Gender flag
examples:
- 0
Male:
type: integer
enum:
- 0
- 1
description: Gender flag
examples:
- 1
age13-17:
type: integer
enum:
- 0
- 1
description: Age flag
examples:
- 1
age18-24:
type: integer
enum:
- 0
- 1
description: Age flag
examples:
- 0
age25-34:
type: integer
enum:
- 0
- 1
description: Age flag
examples:
- 0
age35-44:
type: integer
enum:
- 0
- 1
description: Age flag
examples:
- 0
age45-54:
type: integer
enum:
- 0
- 1
description: Age flag
examples:
- 0
age55-64:
type: integer
enum:
- 0
- 1
description: Age flag
examples:
- 0
age65-:
type: integer
enum:
- 0
- 1
description: Age flag
examples:
- 1
AudienceEthnicity_Top1:
type:
- string
- 'null'
description: Audience ethnicity
default: null
examples:
- Asian
AudienceEthnicityShare_Top1:
type:
- number
- 'null'
description: Audience ethnicity share
default: null
examples:
- 88.888888
AudienceEthnicity_Top2:
type:
- string
- 'null'
description: Audience ethnicity
default: null
examples:
- Asian
AudienceEthnicityShare_Top2:
type:
- number
- 'null'
description: Audience ethnicity share
default: null
examples:
- 88.888888
AudienceEthnicity_Top3:
type:
- string
- 'null'
description: Audience ethnicity
default: null
examples:
- Asian
AudienceEthnicityShare_Top3:
type:
- number
- 'null'
description: Audience ethnicity share
default: null
examples:
- 88.888888
AudienceEthnicity_Top4:
type:
- string
- 'null'
description: Audience ethnicity
default: null
examples:
- Asian
AudienceEthnicityShare_Top4:
type: number
description: Audience ethnicity share
examples:
- 88.888888
AudienceEthnicity_Top5:
type:
- string
- 'null'
description: Audience ethnicity
default: null
examples:
- Asian
AudienceEthnicityShare_Top5:
type:
- number
- 'null'
description: Audience ethnicity share
default: null
examples:
- 88.888888
NetworkUser:
type: string
description: Network user name
examples:
- John Smith
FullLocations:
type: object
properties:
RowNumber:
type: integer
description: Row number
examples:
- 1
SocialId:
type: integer
description: Uniq social Id
examples:
- 9999999
SocialNetworkId:
type: string
description: Uniq social network Id
examples:
- '9999999'
SocialNetworkName:
type: string
description: Social network name
examples:
- John Smith
Network:
type: string
description: Source network
examples:
- instagram
AudienceCountry_Top1:
type:
- string
- 'null'
description: Audience country
default: null
examples:
- USA
AudienceShare_Top1:
type:
- number
- 'null'
description: Audience share top
default: null
examples:
- 88.888888
AudienceCountry_Top2:
type:
- string
- 'null'
description: Audience country
default: null
examples:
- USA
AudienceShare_Top2:
type:
- number
- 'null'
description: Audience share top
default: null
examples:
- 88.888888
AudienceCountry_Top3:
type:
- string
- 'null'
description: Audience country
default: null
examples:
- USA
AudienceShare_Top3:
type:
- number
- 'null'
description: Audience share top
default: null
examples:
- 88.888888
AudienceCountry_Top4:
type:
- string
- 'null'
description: Audience country
default: null
examples:
- USA
AudienceShare_Top4:
type:
- number
- 'null'
description: Audience share top
default: null
examples:
- 88.888888
AudienceState_Top1:
type:
- string
- 'null'
description: Audience state
default: null
examples:
- CA
AudienceStateShare_Top1:
type:
- number
- 'null'
description: Audience state top
default: null
examples:
- 88.888888
AudienceState_Top2:
type:
- string
- 'null'
description: Audience state
default: null
examples:
- CA
AudienceStateShare_Top2:
type:
- number
- 'null'
description: Audience state top
default: null
examples:
- 88.888888
AudienceState_Top3:
type:
- string
- 'null'
description: Audience state
default: null
examples:
- CA
AudienceStateShare_Top3:
type:
- number
- 'null'
description: Audience state top
default: null
examples:
- 88.888888
AudienceState_Top4:
type:
- string
- 'null'
description: Audience state
default: null
examples:
- CA
AudienceStateShare_Top4:
type:
- number
- 'null'
description: Audience state top
default: null
examples:
- 88.888888
AudienceState_Top5:
type:
- string
- 'null'
description: Audience state
default: null
examples:
- CA
AudienceStateShare_Top5:
type:
- number
- 'null'
description: Audience state top
default: null
examples:
- 88.888888
AudienceCity_Top1:
type:
- string
- 'null'
description: Audience city
default: null
examples:
- Selangor, Malaysia
AudienceCityShare_Top1:
type:
- number
- 'null'
default: null
AudienceCity_Top2:
type: string
description: Audience city
examples:
- Selangor, Malaysia
AudienceCityShare_Top2:
type:
- number
- 'null'
description: Audience city top
default: null
examples:
- 88.888888
AudienceCity_Top3:
type:
- string
- 'null'
description: Audience city
default: null
examples:
- Selangor, Malaysia
AudienceCityShare_Top3:
type:
- number
- 'null'
description: Audience city top
default: null
examples:
- 88.888888
AudienceCity_Top4:
type:
- string
- 'null'
description: Audience city
default: null
examples:
- Selangor, Malaysia
AudienceCityShare_Top4:
type:
- number
- 'null'
description: Audience city top
default: null
examples:
- 88.888888
AudienceCity_Top5:
type:
- string
- 'null'
description: Audience city
default: null
examples:
- Selangor, Malaysia
AudienceCityShare_Top5:
type: number
description: Audience city top
examples:
- 88.888888
NetworkUser:
type: string
description: Network user name
examples:
- John Smith
Locations:
type: array
items:
type: object
properties:
RowNumber:
type: integer
description: Row number
examples:
- 1
SocialId:
type: integer
description: Uniq social Id
examples:
- 9999999
SocialNetworkId:
type: string
description: Uniq social network Id
examples:
- '9999999'
SocialNetworkName:
type: string
description: Social network name
examples:
- John Smith
Network:
type: string
description: Source network
examples:
- instagram
Region:
type:
- string
- 'null'
description: Region
default: null
examples:
- Brazil
RegionPercentage:
type:
- number
- 'null'
description: Region percentage
default: null
examples:
- 88.888888
NetworkUser:
type: string
description: Network user name
examples:
- John Smith
PATCHContactDataRequest:
type: object
description: PATCH Contact Data Request
properties:
PrimaryContact:
type: integer
enum:
- 0
- 1
description: PrimaryContact - 0 or 1
format: int32
examples:
- 0
Email:
type: string
description: Primary Email
format: email
examples:
- example@gmail.com
Email1:
type: string
description: Additional Email
format: email
examples:
- example1@gmail.com
FirstName:
type: string
description: Publisher First Name
examples:
- Publisher First Name
LastName:
type: string
description: Publisher Last Name
examples:
- Publisher Last Name
FullName:
type: string
description: Publisher Full Name
examples:
- Publisher Full Name
StreetAddress:
type: string
description: Primary Street Address
examples:
- Street Address, 123
StreetAddress2:
type: string
description: Additional Street Address
examples:
- Street Address, 123
City:
type: string
description: City
examples:
- New York
State:
type: string
description: State
examples:
- Montana
ZipCode:
type: string
description: Zip Code
examples:
- '1000001'
Country:
type: string
description: Country
examples:
- USA
PhoneNumber1:
type: string
description: Primary Phone Number
examples:
- (555) 555-1234
FinanceContact:
type: integer
enum:
- 0
- 1
description: Finance Contact attribute - 0 or 1
format: int32
examples:
- 0
ShipToAddress:
type: integer
enum:
- 0
- 1
description: Ship To Address attribute - 0 or 1
format: int32
examples:
- 1
LegalGuardianContact:
type: integer
enum:
- 0
- 1
description: Legal Guardian Contact - 0 or 1
format: int32
examples:
- 0
ContactType:
type: string
description: Contact Type
examples:
- Publisher
required:
- ContactType
minProperties: 1
MultiplePublishersAccounts_2:
type: object
description: Publishers by IDs as a keys with array of their Social Accounts
patternProperties:
/^[0-9]+$/:
type: array
description: Publisher's Social Accounts
items:
type: object
properties:
PublisherId:
type: integer
examples:
- 99990
NetworkPublisherId:
type: integer
examples:
- 88990
Network:
type: string
enum:
- youtube
- twitter
- facebook
- instagram
- google
- vine
- weibo
- line
- tiktok
- twitch
- tumblr
- pinterest
- snapchat
- linkedin
- reddit
- web
- blog
examples:
- youtube
NotFound:
type: integer
enum:
- 0
- 1
examples:
- 0
isVerifiedBySocialNetwork:
type: integer
enum:
- 0
- 1
examples:
- 1
CreatedBy:
type: string
examples:
- andy.patinkin
CreatedAt:
type:
- string
- 'null'
format: date-time
examples:
- '2018-05-15 23:49:05'
LogoURL:
type: string
format: URI
examples:
- https://yt3.ggpht.com/eijq408tTlu3XbwlIBeu8RsDG4vGTWb2JTOGKuus3sKdAKoxlq770qVga-p3sCT5PHRVEpYfq1M=s800-c-k-c0x00ffffff-no-rj
FollowersCount:
type: integer
examples:
- 4130000
LikesCount:
type:
- integer
- 'null'
examples:
- 213453
CommentsCount:
type:
- integer
- 'null'
examples:
- 2134
ViewsCount:
type:
- integer
- 'null'
examples:
- 121675291
IsBusiness:
type: 'null'
enum:
- 0
- 1
examples:
- 0
Gender:
type:
- string
- 'null'
examples:
- Female
Language:
type:
- string
- 'null'
examples:
- EN
LastUpdated:
type: string
format: date-time
examples:
- '2023-06-26 11:39:03'
Bio:
type: string
examples:
- Hola, yo soy Ari y subo Gameplays de Minecraft y mas
SocialNetworkId:
type: string
examples:
- UCdgKwvFibviy0AzNJCxOQL0
NetworkUser:
type: string
examples:
- '@arigameplays'
FullName:
type: string
examples:
- Ari Gameplays
required:
- PublisherId
- NetworkPublisherId
- Network
responses:
ErrorResponse404PATCHContactData:
description: Supplied ID was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404PATCHContactDataModel'
POSTContactResponse400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/POSTContactResponse400Model'
createPublisherResponse200:
description: Ok
content:
application/json:
schema:
type: object
properties:
type:
const: Publisher
examples:
- Publisher
href:
type: string
examples:
- https://apis.creatoriq.com/crm/v1/api/publisher/10011762349
Publisher:
$ref: '#/components/schemas/PublisherModel'
required:
- type
- href
- Publisher
'403':
description: Access was denied due to the API due to insufficient access permissions.
'401':
description: The request could not be completed due to invalid API credentials
'404':
description: Publisher with supplied ID was not found
400DeleteContactData:
description: Oops! Something went wrong.
POSTContactResponse:
description: Ok
content:
application/json:
schema:
type: object
properties:
type:
const: Address
examples:
- Address
href:
type: string
examples:
- https://apis.creatoriq.com/crm/v1/api/data/contact/117938214
Address:
$ref: '#/components/schemas/AddressModel'
required:
- type
- href
- Address
'400':
description: Bad request, invalid PublisherID format
updatePublisherSocialAccountResponse:
description: Social account data update info
content:
application/json:
schema:
$ref: '#/components/schemas/updatePublisherSocialAccountResponseModel'
securitySchemes:
apiKey:
type: apiKey
name: x-api-key
in: header
x-refined-from:
- creatoriq-publishers-openapi.yml
- creatoriq-v2-publishers-openapi.yml