Search
K
ProducerSync API

Append to the list of active NPNs subscribed to the account

Append to the current list of active NPNs with the new list provided in the request.
This operation is asynchronous

put
https://api.sandbox.agentsync.io/v1/accounts/subscriptions

Body

application/json
array[string]

Response

application/json

Success

Subscription200

successboolean

Example:true

messagestring

Example:Job is in progress

job_idstring

Example:0ded8367-01ac-4519-8cd7-ce965d55c0b0

linksobject
Show Child Parameters
 
application/json

Remove active NPNs subscribed to the account

Request a list of currently active NPNs to un-associated with the account (or delete).

delete
https://api.sandbox.agentsync.io/v1/accounts/subscriptions

Body

application/json
array[string]

Response

Accepted

 

Get the status for an NPN management job

Returns the status and additional metadata about a specific NPN management job

get
https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/{jobId}

Path Parameters

jobIdstring(uuid)required

ID of the job corresponding to the details you are looking for

Response

application/hal+json

Success

idstring(uuid)

Example:0ded8367-01ac-4519-8cd7-ce965d55c0b0

createdAtstring(date)

Date of the creation of this record in AgentSync.

Example:2025-04-14

updatedAtstring(date)

Date of the most recent update to this record in AgentSync.

Example:2025-04-14

detailsobject
Show Child Parameters
linksobject
Show Child Parameters
 
application/hal+json

Get the status details for an NPN management job

Returns the status details about a specific NPN management job

get
https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/{jobId}/details

Path Parameters

jobIdstring(uuid)required

ID of the job corresponding to the details you are looking for

Response

application/hal+json

Success

embeddedobject
Show Child Parameters
linksobject
Show Child Parameters
 
application/hal+json

Producer Addresses

Address information for producers