Get Opportunity CSV Template

Returns a pre-formatted CSV template file for opportunity batch uploads. The template includes all supported column headers with a single example row to illustrate the expected format.

Download this file, populate it with your opportunity data, then submit it to the Upload Opportunity Batch endpoint.

Headers:

AuthorizationstringRequired

The authorization token for accessing the API. The header value should be set to "Bearer {your-access-token}", where {your-access-token} is the access token assigned to the user.

Path Parameters:

siteIdstringRequired

The unique identifier of the site.

Response:

Returns a 200 OK response with Content-Type: text/csv and a Content-Disposition header prompting a download of opportunity_template.csv.

The template includes a header row with all supported columns and one example data row. Remove the example row before uploading real data.

Request
GET
{siteId}/opportunity/template
curl -X GET \
  'https://rest.rulerapi.com/v1/{siteId}/opportunity/template' \
  -H 'Authorization: Bearer {your-access-token}' \
  -o opportunity_template.csv
Response
200 OK
Content-Type: text/csv
Content-Disposition: attachment; filename="opportunity_template.csv"

OpportunityDateTime,CurrencyCode,OpportunityValue,PipelineStage,RaId,EmailAddress,PhoneNumber,PayloadValue,Label,Reference,AdditionalDataProperties
2024-01-15,GBP,1000.00,Proposal,ra-example-id,example@email.com,01234567890,,Deal,REF-001,"Name=Source,Value=Google"