SalesOS.

Campaigns

Marketing campaign management

Campaigns Controller_list Campaigns

GET
/v1/campaigns

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

statusRequiredstring
campaignTypeRequiredstring
curl -X GET "https://api.salesos.org/v1/campaigns?status=%3Cstring%3E&campaignType=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Campaigns Controller_create Campaign

POST
/v1/campaigns

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://api.salesos.org/v1/campaigns" \
  -H "Authorization: Bearer <token>"

Campaigns Controller_get Campaign Stats

GET
/v1/campaigns/stats

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/campaigns/stats" \
  -H "Authorization: Bearer <token>"

Campaigns Controller_get Campaign

GET
/v1/campaigns/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.salesos.org/v1/campaigns/<string>" \
  -H "Authorization: Bearer <token>"

Campaigns Controller_update Campaign

PATCH
/v1/campaigns/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X PATCH "https://api.salesos.org/v1/campaigns/<string>" \
  -H "Authorization: Bearer <token>"

Campaigns Controller_delete Campaign

DELETE
/v1/campaigns/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X DELETE "https://api.salesos.org/v1/campaigns/<string>" \
  -H "Authorization: Bearer <token>"

Campaigns Controller_get Campaign R O I

GET
/v1/campaigns/{id}/roi

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.salesos.org/v1/campaigns/<string>/roi" \
  -H "Authorization: Bearer <token>"

Campaigns Controller_get Campaign Members

GET
/v1/campaigns/{id}/members

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.salesos.org/v1/campaigns/<string>/members" \
  -H "Authorization: Bearer <token>"

Campaigns Controller_get Campaign Performance

GET
/v1/campaigns/{id}/performance

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.salesos.org/v1/campaigns/<string>/performance" \
  -H "Authorization: Bearer <token>"

Notes

Notes on records

Competitors

Competitor tracking and battlecards