Sign in
Business Agent

Set connector credentials

Set or rotate the connector's credentials in place: kind: api_key, kind: oauth (client credentials) or kind: certificate (mTLS client certificate). Meta has no call that removes a credential layer; change the connector's auth_type or delete it instead.

post/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/credentials

Path parameters

accountIdstring required

WhatsApp social account id (the number must be managed through the Cloud API).

connectorIdstring required

Request body

OR
OR

Example request

{
  "oauth_config": {
    "token_request_content_type": "application/x-www-form-urlencoded"
  }
}

Response

Connector with the new credential metadata

namestring required

Unique per number.

descriptionstring

Tell the agent what the service provides.

base_urlstring uri required

Public HTTPS URL reachable from Meta.

connector_protocolstring
auth_type'OAUTH2_CLIENT_CREDENTIALS' | 'API_KEY' | 'NONE' required
requires_certificateboolean
idstring required
mcp_tool_syncobject
mtls_configobject

Example response

{
  "connector_protocol": "HTTP",
  "auth_config": {
    "oauth2_client_credentials": {
      "token_request_content_type": "application/x-www-form-urlencoded"
    }
  },
  "user_auth_injection_config": {
    "location": "headers"
  }
}

Changes

Changed in 4 of the 55 revisions of this API.22

  • 2c04683ce69412See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3e6ddf2a99ea3See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 0dba7d004d756See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 41eff0cffb2d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog