Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Creatorriver Com Contacts API
version: '1'
description: 'Operations tagged contacts across 2 of this provider''s published API definitions: creatorriver-com-openapi.json, creatorriver-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.creatorriver.com/api/v1
security:
- apiKey: []
tags:
- name: Contacts
paths:
/campaigns/{campaignId}/creators/{creatorId}/contact:
post:
operationId: reveal_contact
summary: Reveal a creator’s email for a campaign
description: Returns the creator’s email address so you can contact them in this campaign, adding the creator to the campaign first if needed. Adding unlocks the creator, which costs 0.5 credits the first time for each creator. Revealing costs 0.2 credits the first time for each creator; revealing again, in any campaign, is free. Required before send_email.
tags:
- Contacts
parameters:
- name: campaignId
in: path
required: true
description: Campaign id, from list_campaigns or create_campaign
schema:
type: string
minLength: 1
description: Campaign id, from list_campaigns or create_campaign
- name: creatorId
in: path
required: true
description: Creator id, from search_creators results
schema:
type: string
minLength: 1
description: Creator id, from search_creators results
requestBody:
required: true
content:
application/json:
schema:
type: object
properties: {}
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data: {}
required:
- data
4XX:
description: Failure; `error.code` says what to do
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Failure; `error.code` says what to do
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://www.creatorriver.com/api/v1
components:
schemas:
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
properties:
code:
type: string
enum:
- unauthorized
- not_found
- invalid_input
- insufficient_credits
- rate_limited
- conflict
- internal
message:
type: string
details:
type: object
requestId:
type: string
securitySchemes:
apiKey:
type: http
scheme: bearer
description: An API key from https://www.creatorriver.com/settings/apikeys
x-refined-from:
- creatorriver-com-openapi.json
- creatorriver-com-openapi.yml