Replace billing profile contacts

Replaces the profile's contact list. At most one contact may be the manager. can_view_profile_tickets is a separate opt-in and defaults to false, so naming a manager never widens what they can read.

RBAC · client

Path parameters

idstring <uuid>Required

profileIdstring <uuid>Required

Request body

Content type: application/json · schema BillingProfileContactsBody

contactsarray of objectRequired

Replaces the profile's contact list; omitting a contact removes it.

itemsobject

contact_name_idstring <uuid>Required

is_managerboolean

can_view_profile_ticketsboolean

Response body

Success response 200 · schema BillingProfileContactsEnvelope

dataarray of BillingProfileContactResourceRequired

itemsobject

contact_name_idstring <uuid>Required

full_namestringRequired

emailstringRequiredNullable

is_managerbooleanRequired

can_view_profile_ticketsbooleanRequired

Lets this contact see every ticket attributed to the profile in the client portal.

metaobject

Response codes

200

Billing profile contacts replaced.

400

Invalid payload, a second manager, or a contact from another client.

401

API key missing/invalid or key user not found.

403

Permission denied for client update.

404

Billing profile not found for this client.

500

Unexpected billing profile contacts failure.

PUT /api/v1/clients/{id}/billing-profiles/{profileId}/contacts

cURL

curl -X PUT "https://algapsa.com/api/v1/clients/{id}/billing-profiles/{profileId}/contacts" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contacts": [
    {
      "contact_name_id": "01HN2K7VRB9PQ3Y0000000000",
      "is_manager": false,
      "can_view_profile_tickets": false
    }
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/clients/{id}/billing-profiles/{profileId}/contacts", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "contacts": [
      {
        "contact_name_id": "01HN2K7VRB9PQ3Y0000000000",
        "is_manager": false,
        "can_view_profile_tickets": false
      }
    ]
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/clients/{id}/billing-profiles/{profileId}/contacts");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""contacts"": [
    {
      ""contact_name_id"": ""01HN2K7VRB9PQ3Y0000000000"",
      ""is_manager"": false,
      ""can_view_profile_tickets"": false
    }
  ]
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {
      "contact_name_id": "01HN2K7VRB9PQ3Y0000000000",
      "full_name": "string",
      "email": "string",
      "is_manager": false,
      "can_view_profile_tickets": false
    }
  ],
  "meta": {}
}