Replace opportunity tags

PUT

/api/nova/opportunities/{opportunityId}/tags

Replaces the full set of tags on an opportunity with the tags supplied in the request body; existing tags that are not included are removed. The tags field is required and may be an empty list to clear all tags. Returns 400 when tags is missing and 404 when the opportunity is not found. On success the opportunity id is returned. Responds with 401 for an invalid API key and 429 when API usage limits are exceeded.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

opportunityId*

opportunityId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Request Body

application/json

{

  

"tags": [

  

  

{

  

  

  

"group": "string",

  

  

  

"value": "string"

  

  

}

  

]

}

Responses

OK

Content-Type

application/json

{

  

"data": "string",

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

PUT

/api/nova/opportunities/{opportunityId}/tags

Playground

Authorization

privateApiKey

Variables

Key

Value

opportunityId*

apiKey*

Body

Samples