This section contains the details on the API to retrieve a user's list of accounts.
When the request is successful, then the statusCode will be 200, and a JSON object containing the list of account numbers and account names will be returned.
The account number associated with this username.
Name associated with the account.
This section contains the details on the API to retrieve a user's list of saved distribution.
When the request is successful, then the statusCode will be 200, and a JSON object containing the list of saved distribution ids and names.
The id associated with the saved distribution.
The name associated with the saved distribution.
This section contains the details on the API to submit a C5 order.
Order information
If this is true, then the order will not be submitted, instead the order will be saved under the user's drafts and can be submitted upon login. Setting this flag to false will submit the order.
This object will contain the scheduling details of the order.
{
"accountId": 1010376,
"scheduleType": 3,
"dateAndTime": "2020-06-29 20:49",
"timezoneCode": "ET"
}The accountId of the account that the order is pertaining to. The id can be retrieved from the getAccounts api call.
The code to schedule your release:
Immediate release.
Hold for call.
Release specific time.
The expected format of this string is YYYY-MM-DD HH:SS where HH:SS will be expected to be a 24hr time.
Note: if scheduleType = 3, then this parameter is REQUIRED.
The code for a specific timezone.
Note: if scheduleType = 3, then this parameter is REQUIRED.
Samoa
Hawaii (U.S.)
Alaska Time (U.S.)
Pacific Time (U.S. and Canada)
Arizona
Mountain Time (U.S. and Canada)
Saskatchewan
Central Time (U.S. and Canada)
Jamaica
Eastern Time (U.S. and Canada)
Venezuela Time
Brazil (Sao Paulo)
Atlantic Time (Canada)
Newfoundland
Mid-Atlantic
Cape Verde
Azores Time
British (London)
Ireland (Dublin)
Portugal
Central Europe (Berlin, Frankfurt, Paris, Rome)
Egypt
Eastern Europe (Istanbul)
Moscow Time
Israel
Arabiav
Oman/UAE (Abu Dhabi, Dubai)
Islamabad, Karachi
Pakistan/West Asia
Bangladesh (Astana, Dhaka)
India (Bangalore, Mumbai, New Delhi)
Indochina (Bangkok, Hanoi, Jakarta)
China/Taiwan (Beijing, Hong Kong, Taipei)
Australian Western (Perth)
Japan (Tokyo)
Korea (Seoul)
Australian Central (North)
Australian Central (South)
Australian Eastern (Sydney)
Australian Eastern (Queensland)
Micronesia
New Zealand (Auckland, Wellington)
The distribution object will contain the id for the saved distribution a user has chosen to attach to this order.
{
"savedDistributionId": 2
}The id of the saved distribution attached to this order. The id can be retrieved from the getSavedDistributions api call.
The files that to be associated with this order. Use files key for each file to be upload
Note: At minimum 1 upload for releaseText is required. Additional media is optional.
Note: filename will be used to map each files upload to the files detail.
{
"releaseText": [
{
"filename": "test.txt",
"language": "en"
}
],
"logo": [
{
"filename": "logo.png",
"logoUrl": "https://www.example.com"
}
],
"multimedia": [
{
"filename": "photo.jpg",
"role": 3,
"captions": [
{
"language": "en",
"caption": "caption goes here"
}
]
}
]
}The object containing the order's release text.
The filename that will be mapped to the filename in the uploaded multipart.
The language code of the release text.
English
Spanish
Portuguese
German
French
Italian
Dutch
Danish
Norwegian
Swedish
Finnish
Polish
Czech
Hungarian
Estonian
Latvian
Lithuanian
Japanese
Chinese (Traditional)
Chinese (Simplified)
The object containing the order's logo.
The filename that will be mapped to the filename in the uploaded multipart.
The url for the logo's destination.
The object containing the order's multimedia.
The filename that will be mapped to the filename in the uploaded multipart.
The role for the multimedia upload.
Photo
Logo
Slideshow
Spreadsheet
Document
Audio
Video
Interactive Media-Image
Interactive Media-Video
Text/Table
Message Attachment
The captions in each language for the multimedia upload.
The language code for the caption.
English
Spanish
Portuguese
German
French
Italian
Dutch
Danish
Norwegian
Swedish
Finnish
Polish
Czech
Hungarian
Estonian
Latvian
Lithuanian
Japanese
Chinese (Traditional)
Chinese (Simplified)
The caption string.
The details object will contain all the order details.
{
"requireCopyApproval": false,
"specialInstructions": "example special instructions",
"purchaseOrder": "example number",
"pullQuotesAndTweetThis": {
"disablePullQuote": false,
"disableTweetBtn": false
},
"releaseContact": {
"contactEmail": "test@test.com",
"contactPhone": "123-123-1234"
},
"organizationInformation": {
"securitiesIdentifier": [
{
"tickerSymbol": "APPL",
"exchange": "NYSE",
"isin": "US0004026250"
}
]
},
"socialMedia": {
"socialMediaByLanguage": [
{
"language": "en",
"suggestedTweet": "example suggested tweet",
"socialMediaProfiles": [
{
"network": "Facebook",
"name": "Facebook Profile",
"url": "https://www.facebook.com/test",
"type": "organization"
}
],
"hashTags": [
"#hash"
],
"cashTags": [
"$cash"
]
}
]
}
}This object will define how pull quotes and tweet this will be used for your order.
{
"disablePullQuote": false,
"disableTweetBtn": false
}Enable or disable pull quotes on the order.
Enable or disable tweet this button on the order.
This object will define the details for contact information.
{
"contactEmail": "test@test.com",
"contactPhone": "123-123-1234"
}The contact email for the user.
The contact phone for the user.
This object will define securities information for the order.
{
"securitiesIdentifier": [
{
"tickerSymbol": "APPL",
"exchange": "NYSE",
"isin": "US0004026250"
}
]
}The object containing securities information.
The ticker symbol for the company.
Note: if exchange is provided then this parameter is REQUIRED.
The exchange symbol for the ticker.
Note: if tickerSymbol is provided then this parameter is REQUIRED.
Aequitas NEO Exchange
BX Venture Market
Canadian Securities Exchange
Nasdaq
New York Stock Exchange
NYSE American
NYSE Arca
OTC Bulletin Board
OTCQB
OTCQX
OTC Pink
Toronto Stock Exchange
TSX Venture Exchange
Investors Exchange
Nasdaq Armenia
Athens Stock Exchange
Banjalucka Berza
Bolsa de Barcelona
Beogradska berza
Börse Berlin
Bolsa de Bilbao
Bolsa de Valencia
Burza Cennych Papierov v Bratislave
Bursa de Valori Bucuresti
Budapest Stock Exchange
Balgarska fondova borsa - Sofiya
Channel Islands Stock Exchange
Cboe Global Markets
The Cyprus Stock Exchange
Börse Dusseldorf
Euronext Amsterdam
Euronext Brussels
Euronext Lisbon
Euronext Paris
Euronext.Liffe
FWB Frankfurter Wertpapierbörse
Georgian Stock Exchange
Börse Hamburg
Börse Hannover
NEX Exchange
Euronext Dublin
Borsa Istanbul
LATIBEX
Ljubljanska Borza DD
London Stock Exchange
Luxembourg Stock Exchange
Macedonian Stock Exchange
Bolsa de Madrid
Borza ta' Malta
Borsa Italiana
Montenegro Stock Exchange
Börse Munchen
Nasdaq Copenhagen
Nasdaq Helsinki
Euronext London
Moscow Exchange
Nasdaq Iceland
Nasdaq Stockholm
Oslo Axess
Oslo Børs
Prague Stock Exchange
Nasdaq Riga
Sarajevska Berza
SIX Swiss Exchange Ltd.
Börse Stuttgart
Bursa e Tiranës
Nasdaq Tallinn
Wiener Börse
Nasdaq Vilnius
Warsaw Stock Exchange
XETRA Stock Exchange (Germany)
Zagrebacka burza
Australian Securities Exchange
Bombay (Mumbai) Stock Exchange
MCX-SX
Bursa Malaysia
Calcutta Stock Exchange
Chittagong Stock Exchange Ltd.
Colombo Stock Exchange
Dhaka Stock Exchange
Taipei Exchange
Hong Kong Stock Exchange
JASDAQ
Karachi Stock Exchange
Korea Exchange
KOSDAQ
Nagoya Stock Exchange
National Stock Exchange (of India)
New Zealand Exchange
Sydney Stock Exchange
Philippine Stock Exchange
Port Moresby Stock Exchange
Shanghai Stock Exchange
Shenzhen Stock Exchange
Singapore Exchange
Indonesian Stock Exchange
Taiwan Stock Exchange
Thailand Stock Exchange of
Tokyo Stock Exchange
The Hochiminh Stock Exchange
Abu Dhabi Securities Exchange
Amman Stock Exchange
Bahrain Bourse
Beirut Stock Exchange
Botswana Stock Exchange
Bourse de Casablanca
Bourse de Tunis
Bourse Regionale Des Valeurs Mobilieres S.A.
The Egyptian Exchange
Dar es Salaam Stock Exchange
Nasdaq Dubai
Ghana Stock Exchange
Johannesburg Stock Exchange
Kuwait Stock Exchange
Lusaka Stock Exchange
Malawi Stock Exchange
Nairobi Stock Exchange LTD
Namibian Stock Exchange
The Nigerian Stock Exchange
Stock Exchange of Mauritius
Tehran Stock Exchange
Swaziland Stock Exchange
Saudi Stock Exchange (Tadawul)
Tel-Aviv Stock Exchange
Uganda Securities Exchange
Zimbabwe Stock Exchange
Bahamas International Securities Exchange
Bermuda Stock Exchange
Bolsa de Valores de Colombia
Bolsa Boliviana de Valores
Bolsa de Valores de Guatemala
Bolsa de Valores de Lima
Bolsa de Valores de Nicaragua
Bolsa de Valores de Panama S.A
Bolsa de Valores de Quito
Bolsa Nacional de Valores de Costa Rica
Bolsa de Comercio de Buenos Aires
Bolsa de Valores de Caracas
Cayman Islands Stock Exchange
Jamaica Stock Exchange
Bolsa Mexicana de Valores
Bolsa de Valores do Rio de Janeiro
Bolsa de Comercio de Santiago
Bolsa de Valores Mercadorias & Futuros de Sao Paulo
Trinidad & Tobago Stock Exchange
Valid ISIN associated with the order.
This object contains social media details for the order.
{
"socialMediaByLanguage": [
{
"language": "en",
"suggestedTweet": "example suggested tweet",
"socialMediaProfiles": [
{
"network": "Facebook",
"name": "Facebook Profile",
"url": "https://www.facebook.com/test",
"type": "organization"
}
],
"hashTags": [
"#hash"
],
"cashTags": [
"$cash"
]
}
]
}The language code for the respective social media information.
English
Spanish
Portuguese
German
French
Italian
Dutch
Danish
Norwegian
Swedish
Finnish
Polish
Czech
Hungarian
Estonian
Latvian
Lithuanian
Japanese
Chinese (Traditional)
Chinese (Simplified)
The suggested tweet to display for the order.
The object containing the data for the social media profiles.
The network of the social media profile.
Note: if any of the fields in this object are provided then this parameter is REQUIRED.
The name to be associated with this profile.
Note: if any of the fields in this object are provided then this parameter is REQUIRED.
The url for the social media profile.
Note: if any of the fields in this object are provided then this parameter is REQUIRED.
The type of social media profile.
Note: if any of the fields in this object are provided then this parameter is REQUIRED.
An array of strings of hash tags (Must begin with #).
An array of strings of hash tags (Must begin with $).
A unique identifier to determine order source.
Note: Please reach out to your account representative to generate this key.
{
"sourceKey": "ABCD-EFGH-QRSTU-VWXYZ"
}{ "order": { "refreshToken": "ckkslwrpb002g01ppmfqku6qv", "workInProgress": false, "schedule": { "accountId": 1010376, "scheduleType": 3, "dateAndTime": "2020-06-29 20:49", "timezoneCode": "ET" }, "distribution": { "savedDistributionId": 2 }, "files": { "releaseText": [ { "filename": "test.txt", "language": "en" } ], "logo": [ { "filename": "logo.png", "logoUrl": "https://www.example.com" } ], "multimedia": [ { "filename": "photo.jpg", "role": 3, "captions": [ { "language": "en", "caption": "caption goes here" } ] } ] }, "details": { "requireCopyApproval": false, "specialInstructions": "example special instructions", "purchaseOrder": "example number", "pullQuotesAndTweetThis": { "disablePullQuote": false, "disableTweetBtn": false }, "releaseContact": { "contactEmail": "test@test.com", "contactPhone": "123-123-1234" }, "organizationInformation": { "securitiesIdentifier": [ { "tickerSymbol": "APPL", "exchange": "NYSE", "isin": "US0004026250" } ] }, "socialMedia": { "socialMediaByLanguage": [ { "language": "en", "suggestedTweet": "Example suggested tweet", "socialMediaProfiles": [ { "network": "Facebook", "name": "Profile Name", "url": "https://www.facebook.com/test", "type": "organization" } ], "hashTags": [ "#hash" ], "cashTags": [ "$cash" ] } ] }, "sourceKey": "ABCD-EFGH-QRSTU-VWXYZ" } } }
On successful login, a statusCode of 200 will be returned and the JWT can be found in the Header with the key : x-auth-token.
A refreshToken will also be provided with the key x-refresh-token that will be used to create new access tokens.