Create Custom Source

POST

https://platform-api.convirza.com/v3/custom-source

Custom Source

Last modified:2026-07-24 13:10:44

Creates one or more custom sources for tracking.

Request Body
Send an array of custom source objects to create multiple sources at once.

Required Fields (per custom source)

custom_source_name — unique name within the organization

org_unit_id — must reference an existing, active organization unit

Optional Fields

custom_source_type — defaults to "CS1" if not provided

Business Rules

Custom source names must be unique within the organization hierarchy

Duplicate names within the same request are not allowed

All sources in the request are created atomically (all or nothing)

Example Request

[
  {
    "custom_source_name": "Facebook Ads",
    "org_unit_id": 1001,
    "custom_source_type": "CS1"
  },
  {
    "custom_source_name": "Google Ads",
    "org_unit_id": 1001
  }
]

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Custom sources created successfully

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

cURL

Create Multiple Custom SourcesCreate Single Custom Source

curl --location 'https://platform-api.convirza.com/v3/custom-source' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
    {
        "custom_source_name": "Facebook Ads",
        "org_unit_id": 1001,
        "custom_source_type": "CS1"
    },
    {
        "custom_source_name": "Google Ads",
        "org_unit_id": 1001
    }
]'

Response Example

201 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "message": "Successfully created custom_sources",
        "ids": [
            123,
            124
        ]
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-07-24 13:10:44

Get Custom Sources

Delete Custom Sources (Single or Multiple)