Update an Existing Subscription — Guide

First-request guide for Update an Existing Subscription.

API GUIDE

Update an Existing Subscription

Update an Existing Subscription

PUT/subscriptions/jobJSONAuthentication required

Overview

Use this API to update an existing subscription. You must provide both the subscriptionId and subscriptionType to identify which subscription you want to modify. This endpoint supports partial and full updates, including: - Replacing all associated entity IDs with the subscription (e.g., company IDs or dbPerson IDs). - Incrementally adding or removing entity IDs in the subscription. - Updating other subscription details such as frequency, webhook URL, signing secret, fields, or news categories. The API responds with a jobId, which can be used to check the job's status. Once the job completes successfully, the subscription is updated accordin…

Call the endpoint

Send a PUT request to /subscriptions/job with the required authentication and parameters.

Build the request body

Use the JSON shape below and replace example values with your data.

Inspect the response

Use the success response shape to validate the fields your integration receives.

Quickstart

Follow these two steps to make a request and recognize a successful response.

STEP 1

Make a request

REQUEST
curl --request PUT \
  --url https://uapi.demandbase.com/data/b2b/v1/subscriptions/job \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"subscriptionId":"2aac4dd2-d2c9-485e-b9ef-388c63e54915","companyIds":[1,2,3,4,5],"name":"Updated Company Subscription","description":"This is an updated subscription for company updates","subscriptionType":"company","frequency":"14d","fields":["all"],"webhook":"http://www.your-domain.com/webhook-updated","signingSecret":"updated-secret-key"}'
STEP 2

Read the response

SUCCESS RESPONSE · HTTP 202
{
  "jobId": "39ddf756-c04e-465c-b8c1-8d2c2be0abed",
  "jobStatus": "accepted",
  "totalEntitiesProcessed": 0,
  "jobType": "notificationSubscriptionCreate",
  "subscriptionType": "company",
  "createdAt": "2025-06-25T09:00:42.620Z"
}

Request anatomy

Build the request from the method, path, parameters, and payload described below.

Parameters

This endpoint does not define additional parameters.

Request body

No fields are defined for this payload.

Response anatomy

The endpoint returns 202 for the documented success case. Successful operation

The response schema does not enumerate fields; inspect the example response and status code.

Rules

  • Use PUT with the path /subscriptions/job.
  • Required inputs: No parameters are marked required in the published schema..
  • Authenticate every request with a valid Demandbase access token.
  • Send the request body as application/json.

Filters

This endpoint has no additional filters or parameters beyond its authentication requirements.

Errors

Handle non-success responses explicitly so your integration can report actionable failures.

StatusMeaning
400Bad Request
401Unauthorized because the user is not authenticated.

Next steps

Try the quickstart

Start with the request example, then replace the sample values with your credentials and data.

Return to the API area

Back to subscription-api

Back to top