> ## Documentation Index > Fetch the complete documentation index at: https://docs.tolt.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a partner > Edits profile fields and group membership. Status changes go through the approve, reject and suspend actions. ## OpenAPI ````yaml /api-reference/openapi.json put /v2/partners/{id} openapi: 3.1.0 info: title: Tolt Public API version: 2.0.0 servers: - url: https://platform.tolt.dev description: Development security: - bearerAuth: [] paths: /v2/partners/{id}: put: tags: - Partners summary: Update a partner description: >- Edits profile fields and group membership. Status changes go through the approve, reject and suspend actions. operationId: updatePartner parameters: - schema: type: string example: part_NLYzgNKuSuASvrvoxNtau6SY required: true name: id in: path requestBody: required: true content: application/json: schema: type: object properties: first_name: type: - string - 'null' minLength: 1 maxLength: 150 description: >- Partner's first name, part of the name shown for them unless they have a display name; null clears it. example: Sam last_name: type: - string - 'null' minLength: 1 maxLength: 150 description: >- Partner's family name, shown with first_name in the dashboard and partner portal; null clears it. example: Rivera company_name: type: - string - 'null' minLength: 1 maxLength: 255 description: Business the partner promotes through; null clears it. example: Acme country_code: type: - string - 'null' pattern: ^[A-Za-z]{2}$ description: >- Partner's country as a two-letter ISO code. Commission flows can match on it. example: US website_url: type: - string - 'null' maxLength: 2048 format: uri pattern: ^https?:\/\/[^\s/\\]\S*$ description: >- URL of the partner's website, starting with http:// or https://; null clears it. example: https://acme.com group_id: type: - string - 'null' minLength: 1 description: >- Id of a group in the partner's program to move them to (grp_...), as returned when listing groups. Commission flows scoped to that group then apply to them; null removes them from their group. example: grp_1a2b3c minProperties: 1 example: first_name: Sam last_name: Taylor group_id: grp_zUQ8Pt281MsbNDApmDPN3Y2a responses: '200': description: The updated partner content: application/json: schema: type: object properties: success: type: boolean example: true message: type: string example: Request successful data: $ref: '#/components/schemas/Partner' required: - success - message - data example: success: true message: Successfully updated partner data: id: part_NLYzgNKuSuASvrvoxNtau6SY email: sam@example.com first_name: Sam last_name: Taylor company_name: Sam's Studio status: active group_id: grp_zUQ8Pt281MsbNDApmDPN3Y2a program_id: prg_T6z8aRW3XCmvFWP972RKxpAd country_code: US website_url: https://partner.example.com display_name: Sam Taylor completed_onboarding: true created_at: '2026-10-01T12:00:00Z' updated_at: '2026-10-01T12:00:00Z' rejected_at: null suspended_at: null headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false message: 'request: Invalid input: expected object, received null' code: validation_error doc_url: https://docs.tolt.com/errors#validation_error errors: - field: request message: 'Invalid input: expected object, received null' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '401': description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false message: Unauthorized code: unauthorized doc_url: https://docs.tolt.com/errors#unauthorized '404': description: Partner not found content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false message: Partner not found code: not_found doc_url: https://docs.tolt.com/errors#not_found headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '413': $ref: '#/components/responses/PayloadTooLarge' '429': $ref: '#/components/responses/RateLimited' components: schemas: Partner: type: object properties: id: type: string example: part_NLYzgNKuSuASvrvoxNtau6SY email: type: string example: sam@example.com first_name: type: - string - 'null' example: Sam last_name: type: - string - 'null' example: Taylor company_name: type: - string - 'null' example: Sam's Studio status: type: string example: active group_id: type: - string - 'null' example: grp_zUQ8Pt281MsbNDApmDPN3Y2a program_id: type: - string - 'null' example: prg_T6z8aRW3XCmvFWP972RKxpAd country_code: type: - string - 'null' example: US website_url: type: - string - 'null' example: https://partner.example.com display_name: type: - string - 'null' description: Name shown for the partner in the dashboard. example: Sam Taylor completed_onboarding: type: - boolean - 'null' example: true created_at: type: string format: date-time example: '2026-10-01T12:00:00Z' updated_at: type: string format: date-time example: '2026-10-01T12:00:00Z' rejected_at: anyOf: - type: string format: date-time example: '2026-10-01T12:00:00Z' - type: 'null' example: null suspended_at: anyOf: - type: string format: date-time example: '2026-10-01T12:00:00Z' - type: 'null' example: null required: - id - email - first_name - last_name - company_name - status - group_id - program_id - country_code - website_url - display_name - completed_onboarding - created_at - updated_at - rejected_at - suspended_at Error: type: object properties: success: type: boolean example: false message: type: string description: Human-readable explanation. May change; branch on code instead. code: type: string enum: - bad_request - validation_error - invalid_reference - invalid_cursor - unauthorized - forbidden - not_found - conflict - already_exists - commission_paid - commission_frozen - transaction_refunded - commission_exists - rate_limited - payload_too_large - internal_error description: Stable machine-readable error code. example: not_found doc_url: type: string example: https://docs.tolt.com/errors#not_found errors: type: array items: type: object properties: field: type: string message: type: string required: - field - message description: >- One entry per offending field. Present on validation_error and invalid_reference. required: - success - message - code - doc_url headers: X-RateLimit-Limit: description: Requests allowed in the current window. schema: type: integer X-RateLimit-Remaining: description: Requests left in the current window. schema: type: integer X-RateLimit-Reset: description: Unix time, in seconds, when the window resets. schema: type: integer Retry-After: description: Seconds to wait before retrying. schema: type: integer responses: PayloadTooLarge: description: Request body exceeds 1 MB content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false message: Request body exceeds 1 MB code: payload_too_large doc_url: https://docs.tolt.com/errors#payload_too_large RateLimited: description: The API key exceeded its rate limit headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false message: Too many requests. Retry after the window resets. code: rate_limited doc_url: https://docs.tolt.com/errors#rate_limited securitySchemes: bearerAuth: type: http scheme: bearer description: Tolt API key sent as a bearer token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.