Marketing 360®
API docs by Redocly

Marketing 360® API (1.0.0)

Download OpenAPI specification:Download

Support: support@marketing360.com URL: https://support.marketing360.com License: UNLICENSED Terms of Service

Introduction

The Marketing 360® REST API provides programmatic access to select resources in the Marketing 360® platform.

The base URL for all endpoints is: https://api.marketing360.com/v1

Authentication

The Marketing 360® API uses API keys to authenticate requests. You can view and manage your API keys in the Developers tab of your Marketing 360® Account settings. You must have the Owner or Admin account role to manage API keys.

You can use restricted API keys for granular permissions by selecting the specific access the key has when creating it.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, etc.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key Client ID and Client Secret as the basic auth username and password, respectively.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Rate Limiting

The Marketing 360® API implements leaky bucket rate limiting. All endpoints are limited to 5 requests per second per API key, unless otherwise specified. The following HTTP headers are included in every response to provide current rate limit stats:

  • X-Rate-Limit-Limit: The per-second rate limit for the current endpoint
  • X-Rate-Limit-Remaining: The number of requests remaining in the current time period
  • X-Rate-Limit-Reset: An epoch timestamp of when the limit resets

Troubleshooting

  • If you run into problems making requests that contain a body, ensure the Content-Length and Content-Type HTTP headers are included in the request

Accounts

Endpoints related to core accounts

Account

Authorizations:
basicAuth

Responses

Contacts

Endpoints related to CRM contacts

Contacts Index

Retrieve a list of an account's contacts.

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1
pageSize
integer >= 0
Default: 25
Example: pageSize=25

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "page": 1,
  • "pageSize": 0,
  • "totalResults": 0
}

Contacts Index With Filters

Retrieve a list of an account's contacts, limited by filters entered in the request body.

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1
pageSize
integer >= 0
Default: 25
Example: pageSize=25
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "page": 1,
  • "pageSize": 0,
  • "totalResults": 0
}

Contact Create

Create a new contact.

Authorizations:
basicAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "success": 0
}

Contact Update

Update an existing contact.

Authorizations:
basicAuth
path Parameters
id
required
integer
Example: null

The ID of the contact to be updated.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "success": 0
}

Contact View

Retrieve information about a single contact, by ID.

Authorizations:
basicAuth
path Parameters
id
required
integer
Example: null

The ID of the contact to view.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created": 0,
  • "updated": 0,
  • "nextContact": 0,
  • "source": {
    },
  • "assignees": {
    },
  • "types": [
    ],
  • "statuses": [
    ],
  • "contactName": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "tags": [
    ],
  • "additionalInfo": "string",
  • "profileImage": "http://example.com",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "customFields": [
    ],
  • "firstName": "string",
  • "lastName": "string",
  • "sourceByType": "string",
  • "organizationid": 0
}

Contact Delete

Delete a contact by ID.

Authorizations:
basicAuth
path Parameters
id
required
integer
Example: null

The ID of the contact to be deleted.

Responses

Response samples

Content type
application/json
{
  • "success": 0
}

Custom Fields

Endpoints related to CRM custom fields

Custom Fields

Retrieve a list of an account's custom fields.

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1
pageSize
integer >= 0
Default: 25
Example: pageSize=25

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "page": 1,
  • "pageSize": 0,
  • "totalResults": 0
}

Custom Fields (With Filters)

Retrieve a filtered list of an account's custom fields.

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1
pageSize
integer >= 0
Default: 25
Example: pageSize=25
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "page": 1,
  • "pageSize": 0,
  • "totalResults": 0
}

Contact Statuses

Endpoints related to CRM contact statuses

Custom Statuses

Retrieve a list of an account's crm statuses.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "page": 1,
  • "pageSize": 0,
  • "totalResults": 0
}

Contact Types

Endpoints related to CRM contact types

Custom Types

Retrieve a list of an account's crm types.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "page": 1,
  • "pageSize": 0,
  • "totalResults": 0
}

Contact Sources

Endpoints related to CRM contact sources

Contact Sources

Retrieve a list of an account's crm sources.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "page": 1,
  • "pageSize": 0,
  • "totalResults": 0
}

Tasks

Endpoints related to CRM Tasks

Tasks Create

Create a CRM task.

Authorizations:
basicAuth
Request Body schema: application/json
optional
object (CRMTasksRequest)

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Task created successfully.",
  • "id": 1234
}

Tasks Update

Update a CRM task.

Authorizations:
basicAuth
path Parameters
id
required
integer
Example: 5

The ID of the task to update.

Request Body schema: application/json
optional
object (CRMTasksRequest)

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Task updated successfully.",
  • "id": 1234
}

Users

Endpoints related to CRM users

Contact Assignees

Retrieve a list of users who could potentially be assigned to a contact.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Leads

Endpoints related to CRM leads

Create or update a Zapier lead

Create or update a Zapier lead. An update is triggered when an existing lead with the same email exists. Email is the primary key used to dedupe leads.

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (CRMCreateZapierLead)

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "created": 1648236117,
  • "updated": 1648236117,
  • "leadSource": {
    }
}

Lead Sources

Endpoints related to CRM lead sources

List Lead Sources

List Lead Sources

Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1
pageSize
integer >= 0
Default: 25
Example: pageSize=25
type
required
string (CRMLeadSourceType)
Value: "zap"
Example: type=zap
provider
string (CRMLeadSourceProvider)
Value: "zapier"
Example: provider=zapier
search
string
Example: search=test search term

A search term. Title and name will be searched.

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ],
  • "pagination": {
    }
}

Account

Endpoints related to payment accounts

Account

Get Payment Account information.

Authorizations:
basicAuth

Responses

Charges

Endpoints related to payment charges

Capture Charge

https://stripe.com/docs/api/charges/capture

Authorizations:
basicAuth
path Parameters
id
required
string
Example: null

Responses

Create Charge

https://stripe.com/docs/api/charges/create

Authorizations:
basicAuth

Responses

Customers

Endpoints related to payment customers

Create Customer

https://stripe.com/docs/api/customers/create

Authorizations:
basicAuth

Responses

List Customers

https://stripe.com/docs/api/customers/list

Authorizations:
basicAuth

Responses

Retrieve Customer

https://stripe.com/docs/api/customers/retrieve

Authorizations:
basicAuth
path Parameters
id
required
string
Example: null

Responses

Update Customer

https://stripe.com/docs/api/customers/update

Authorizations:
basicAuth
path Parameters
id
required
string
Example: null

Responses

Payment Intents

Endpoints related to payment intents

Cancel PaymentIntent

https://stripe.com/docs/api/payment_intents/cancel

Authorizations:
basicAuth
path Parameters
id
required
string
Example: null

Responses

Capture PaymentIntent

https://stripe.com/docs/api/payment_intents/capture

Authorizations:
basicAuth
path Parameters
id
required
string
Example: null

Responses

Confirm PaymentIntent

https://stripe.com/docs/api/payment_intents/confirm

Authorizations:
basicAuth
path Parameters
id
required
string
Example: null

Responses

Retrieve PaymentIntent

https://stripe.com/docs/api/payment_intents/retrieve

Authorizations:
basicAuth
path Parameters
id
required
string
Example: null

Responses

Update PaymentIntent

https://stripe.com/docs/api/payment_intents/update

Authorizations:
basicAuth
path Parameters
id
required
string
Example: null

Responses

Refunds

Endpoints related to payment refunds

Create Refund

https://stripe.com/docs/api/refunds/create

Authorizations:
basicAuth

Responses

Setup Intents

Endpoints related to payment setup intents

Create SetupIntent

https://stripe.com/docs/api/setup_intents/create

Authorizations:
basicAuth

Responses

Retrieve SetupIntent

https://stripe.com/docs/api/setup_intents/retrieve

Authorizations:
basicAuth
path Parameters
id
required
string
Example: null

Responses

Webhooks

Endpoints related to payment webhooks

Update Webhook

Authorizations:
basicAuth
path Parameters
webhookdId
required
string
Example: null

Responses

Unregister Webhook

Unregister your application from receiving webhooks.

Authorizations:
basicAuth
path Parameters
webhookdId
required
string
Example: null

Responses

Register Webhook

Register your application to receive webhook callouts.

Authorizations:
basicAuth

Responses

List Webhooks

Returns a list of your webhook endpoints.

Authorizations:
basicAuth

Responses

Sources

Endpoints related to payment sources

Retrieve Source

Authorizations:
basicAuth
path Parameters
id
required
string
Example: null

Responses