Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
admin

/api/v1/admin/participant (POST)

POST
/api/v1/admin/participant
curl --request POST \
  --url https://dpg.example.com/api/v1/admin/participant \
  --header 'Content-Type: application/json' \
  --header 'x-acting-org-id: example' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "email": "hello@example.com", "phone_number": "example", "name": "example", "age": 1, "compliance": [ { "key": "example", "value": true } ], "channel": "bulk", "source_id": "example", "item_state": { "additionalProperty": "example" }, "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "network": "example", "domain": "example", "item_type": "example", "item_locations": [ { "lat": 1, "lng": 1, "label": "example" } ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-acting-org-id
required
string

Organization this request acts on behalf of. Required for admin/aggregator operations.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
string format: email
/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
phone_number
string
/^\+\d{10,15}$/
name
required
string
>= 1 characters
age
integer
<= 120
compliance
Array<object>
object
key
required
string
>= 1 characters
value
required
boolean
channel
required
string
Allowed values: bulk link voice self
source_id
string
>= 1 characters
item_state

Payload written to the items table. If absent OR an empty object {} with NO item_id, the route enters account_only mode (only the user is created/looked up, no item is written). If absent/empty WITH an item_id, that profile is targeted for a consent/DOB update without changing its fields.

object
key
additional properties
item_id

UUID. Meaningful when the user already exists AND the caller owns them — network_service, or the aggregator that onboarded the user (#309 activation). Targets that specific item for a PATCH-style update. Ignored otherwise.

string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
network

Network id (default: ‘blue_dot’). Set when this Signals instance serves a different network.

string
>= 1 characters
domain

Domain within the network (default: ‘seeker’). REQUIRED when acting on behalf of a non-aggregator org (voice / network_service): it selects which default aggregator owns the participant, so the ‘seeker’ fallback would mis-assign a provider signup. Omitting it there returns 400 DOMAIN_REQUIRED. Aggregator callers own their own onboards and may omit it.

string
>= 1 characters
item_type

Schema-typed item_type for the item (default: ‘profile_1.0’).

string
>= 1 characters
item_locations

Exact coordinates the caller already resolved for this item (e.g. an address the participant picked from a Places autocomplete, so the lat/lng is the one the geocoder returned for that exact suggestion). When present and non-empty these are stored as-is and the address text in item_state is NOT geocoded server-side. When absent or empty, Signals geocodes the item schema’s primary location field from item_state, which is the historical behaviour. Privacy is unaffected either way: if the primary location field is declared private, the coordinate is jittered 100-250 m before storage regardless of whether it was supplied here or resolved server-side.

Array<object>
object
lat
required
number
>= -90 <= 90
lng
required
number
>= -180 <= 180
label
string

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
user_id
required
string
user_existed
required
boolean
owned_elsewhere
required
boolean
onboarded_at
required
string format: date-time
nullable /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
items
required

Ordered newest first by created_at (ties broken by item_id), so a caller that reads only the head of the list gets the participant’s most recent profile.

Array<object>
object
item_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
item_network
required
string
item_domain
required
string
item_type
required
string
lifecycle_status
string
profile_consent_accepted
boolean
item_state
required
object
key
additional properties
item_locations
required
Array<object>
object
lat
required
number
>= -90 <= 90
lng
required
number
>= -180 <= 180
label
string
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
updated_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
consent_recorded
integer
>= -9007199254740991 <= 9007199254740991
onboarded_by_org_id
string
nullable
onboarded_by_default
boolean
Examplegenerated
{
  "user_id": "example",
  "user_existed": true,
  "owned_elsewhere": true,
  "onboarded_at": "2026-04-15T12:00:00Z",
  "items": [
    {
      "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "item_network": "example",
      "item_domain": "example",
      "item_type": "example",
      "lifecycle_status": "example",
      "profile_consent_accepted": true,
      "item_state": {
        "additionalProperty": "example"
      },
      "item_locations": [
        {
          "lat": 1,
          "lng": 1,
          "label": "example"
        }
      ],
      "created_at": "2026-04-15T12:00:00Z",
      "updated_at": "2026-04-15T12:00:00Z"
    }
  ],
  "consent_recorded": 1,
  "onboarded_by_org_id": "example",
  "onboarded_by_default": true
}