Create campaign
POST/v1/partnership/campaigns
Create a campaign and its initial tracking link. Supply the campaign metadata and reward schema, then use the returned campaign_code for subsequent campaign and reporting requests.
Required scopes:
- write:
partnership.all.
Rules:
titlecan contain up to 100 characters.partner_code, when supplied, can contain up to 10 characters.
Rate limits:
- This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.
Consistency and recovery notes:
- The current Partnership API does not provide idempotent-write semantics. After a timeout or connection failure, read the affected resource or list before deciding whether to retry.
Possible errors:
ThrottledServiceTransportErrorErrorAuthenticationFailedPermissionDeniedValidationErrorNotFoundNotUniqueManyItems
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
- 502
- 503
- 504
Successful response.
Invalid campaign or campaign-link request, including the conflicts and limits declared by the operation. The response uses the numeric request-processing or Partnership string-code envelope.
Authentication failed. Authentication processing errors use numeric codes; a Partnership operation authentication error uses a string code.
Operation is not permitted for the authenticated API key, partner, or operation scope.
Requested resource was not found or is not visible to the authenticated partner.
Rate limit exceeded.
Response Headers
Seconds to wait before retrying when the API provides a throttle wait time.
The API or a service required by the operation could not complete the request.
The API could not complete the request to the Partnership service.
A required service is temporarily unavailable or the request deadline was exceeded.
A service required by the Partnership operation could not be reached or timed out.