Update the caller aggregator profile

PATCH

/v1/aggregators/profile/me

const url = 'https://aggregator.example.com/v1/aggregators/profile/me';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"aggregator":{"name":"example","url":"https://example.com","contact":{"name":"example","phone":"example","email":"hello@example.com","alternatePhone":"example","company":"example","gstNumber":"example"},"locations":[{"geo":{"type":"Point","coordinates":["example"],"geometries":["example"],"bbox":[1]},"address":{"streetAddress":"example","extendedAddress":"example","addressLocality":"example","addressRegion":"example","postalCode":"example","addressCountry":"example"}}],"consent":{"value":true,"given_at":"2026-04-15T12:00:00Z","valid_till":"2026-04-15T12:00:00Z"}},"profile":{"contact_name":"example","personas":[{"id":"example","name":"example"}],"services":[{"id":"example","name":"example"}],"verified_certificate":[{"key_id":"example","public_key":"example","algorithm":"example","valid_till":"2026-04-15T12:00:00Z","revoked_at":"2026-04-15T12:00:00Z"}]}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://aggregator.example.com/v1/aggregators/profile/me \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "aggregator": { "name": "example", "url": "https://example.com", "contact": { "name": "example", "phone": "example", "email": "hello@example.com", "alternatePhone": "example", "company": "example", "gstNumber": "example" }, "locations": [ { "geo": { "type": "Point", "coordinates": [ "example" ], "geometries": [ "example" ], "bbox": [ 1 ] }, "address": { "streetAddress": "example", "extendedAddress": "example", "addressLocality": "example", "addressRegion": "example", "postalCode": "example", "addressCountry": "example" } } ], "consent": { "value": true, "given_at": "2026-04-15T12:00:00Z", "valid_till": "2026-04-15T12:00:00Z" } }, "profile": { "contact_name": "example", "personas": [ { "id": "example", "name": "example" } ], "services": [ { "id": "example", "name": "example" } ], "verified_certificate": [ { "key_id": "example", "public_key": "example", "algorithm": "example", "valid_till": "2026-04-15T12:00:00Z", "revoked_at": "2026-04-15T12:00:00Z" } ] } }'

Partial update of profile fields (contact, locations, etc) for the caller aggregator. Validates the patch against profile.v1.json. Re-syncs to signalstack on success.

Authorizations

bearerAuth

Request Body^required

application/json

object

aggregator

object

name

string

>= 2 characters <= 200 characters

url

string format: uri

nullable <= 2048 characters

contact

object

name

required

string

>= 1 characters <= 200 characters

phone

required

string

/^(\+?\d{10,15}|\d{10})$/

email

required

string format: email

<= 320 characters

alternatePhone

string

/^(\+?\d{10,15}|\d{10})$/

company

string

<= 200 characters

gstNumber

string

<= 32 characters

locations

Array<object>

object

geo

required

object

type

required

string

Allowed values: Point LineString Polygon MultiPoint MultiLineString MultiPolygon GeometryCollection

coordinates

Array

geometries

Array

bbox

Array<number>

>= 4 items <= 4 items

address

object

streetAddress

string

extendedAddress

string

addressLocality

string

addressRegion

string

postalCode

string

addressCountry

string

consent

object

value

required

boolean

given_at

required

string format: date-time

valid_till

required

string format: date-time

profile

object

contact_name

string

nullable >= 1 characters <= 200 characters

personas

Array<object>

object

required

string

>= 1 characters

name

required

string

>= 1 characters

services

Array<object>

object

required

string

>= 1 characters

name

required

string

>= 1 characters

verified_certificate

Array<object>

object

key_id

required

string

>= 1 characters

public_key

required

string

>= 1 characters

algorithm

required

string

>= 1 characters

valid_till

required

string format: date-time

revoked_at

string format: date-time

Responses

200

Default Response

application/json

object

aggregator_id

required

string

org_slug

required

string

actor_type

required

string

type

required

string

nullable

url

required

string

nullable

contact

required

object

name

required

string

>= 1 characters <= 200 characters

phone

required

string

/^(\+?\d{10,15}|\d{10})$/

email

required

string format: email

<= 320 characters

alternatePhone

string

/^(\+?\d{10,15}|\d{10})$/

company

string

<= 200 characters

gstNumber

string

<= 32 characters

locations

required

Array<object>

object

geo

required

object

type

required

string

Allowed values: Point LineString Polygon MultiPoint MultiLineString MultiPolygon GeometryCollection

coordinates

Array

geometries

Array

bbox

Array<number>

>= 4 items <= 4 items

address

object

streetAddress

string

extendedAddress

string

addressLocality

string

addressRegion

string

postalCode

string

addressCountry

string

consent

required

object

value

required

boolean

given_at

required

string format: date-time

valid_till

required

string format: date-time

status

required

string

contact_name

required

string

nullable

personas

required

Array<object>

object

required

string

>= 1 characters

name

required

string

>= 1 characters

services

required

Array<object>

object

required

string

>= 1 characters

name

required

string

>= 1 characters

verified_certificate

required

Array<object>

object

key_id

required

string

>= 1 characters

public_key

required

string

>= 1 characters

algorithm

required

string

>= 1 characters

valid_till

required

string format: date-time

revoked_at

string format: date-time

profile_completed_at

required

string

nullable

is_complete

required

boolean

updated_at

required

string

name

required

string

key

additional properties

any

Example

{
  "locations": [
    {
      "geo": {
        "type": "Point"
      }
    }
  ]
}

400

Default Response

application/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

401

Default Response

application/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

403

Default Response

application/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

404

Default Response

application/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

409

Default Response

application/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

500

Default Response

application/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

503

Default Response

application/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

Update the caller aggregator profile

Authorizations

Request Bodyrequired

Responses

200

Example

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

500

Examplegenerated

503

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated